#notebook #journal

bin+lib notebook_rs

CLI utility for plaintext notetaking

9 unstable releases (4 breaking)

0.5.0 Sep 24, 2022
0.4.1 Sep 23, 2022
0.4.0 Feb 16, 2022
0.3.0 Feb 7, 2022
0.1.1 Apr 21, 2021

#1814 in Command line utilities

34 downloads per month

MIT license

29KB
718 lines

CI crates.io

notebook_rs

CLI tool for maintaining plaintext notebooks, formatted as Markdown by default.

Still very much a work in progress.

On first use, it will create a config file in the OS specific config directory (e.g. ~/.config/notebook_rs/). The default notebook location is $HOME/Documents.

Performs a fairly simple sentiment analysis on the text by default, using a Rust implementation of the VADER tool.

Commands

  • nb -c Path to config file
  • nb -h Summary of commands available
  • nb -n Opens $EDITOR for inputting text
  • nb -n <text> Parse entry text from the commandline
  • nb -l <n> List n most recent entries, use with -v for extra output
  • nb -r <n> Display entry n
  • nb -e <n> Edit entry n in system editor
  • nb -d <n> Delete entry n
  • nb -s <pattern> Search for pattern in entries

Config settings

Planned features

  • Search functionality
    • Full-text search with regex
    • Search by date range
  • Parsing tags from text
  • File encryption
  • Editing entries
  • Deleting entries
  • Alternative TUI

Dependencies

~5.5–7.5MB
~130K SLoC