notebook_rs 0.2.2

CLI utility for plaintext notetaking
Documentation

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 -h Summary of commands available
  • nb -n Opens $EDITOR for inputting text
  • nb -n <text> Parses text from the commandline
  • nb -l <n> Lists n most recent entries, use with -v for extra output
  • nb -r <n> Displays entry n
  • nb -e <n> Edit entry in system editor

Config settings

Planned features

  • Search functionality
  • Parsing tags from text
  • File encryption
  • Editing entries
  • Deleting entries
  • Alternative TUI