notes 📝

notes is a simple command-line utility that helps with managing a flat directory of notes powered by fzf, fd and ripgrep.

Installation

You can install the script onto your machine by simply copying it into the appropriate location:

curl https://raw.githubusercontent.com/terror/notes/master/notes -o /usr/local/bin/notes
chmod +x /usr/local/bin/notes

Dependencies

notes requires a few environment variables to be set, namely:

• $EDITOR: The text editor you'll be editing your notes with [default: vim]
• $NOTE_DIR: Path to your notes directory [default: ~/notes]
• $NOTE_EXT: File extension of your notes [default: md]
• $NOTE_FORMAT_COMMAND: Command to run when formatting notes [default: prettier --print-width 80 --prose-wrap always --single-quote true --tab-width 2 --write]

Moreover, a few external dependencies are required for full usage of the program, namely:

• bat - A cat clone
• fd - A fast and user-friendly alternative to find
• fzf - A fuzzy file finder
• prettier (if $NOTE_FORMAT_COMMAND is set to use it) - A document formatter
• rg - A line-oriented search tool

Usage

Below are the available ways you can interact with the program:

A simple note management CLI powered by fzf, fd, and ripgrep.

Usage: notes [COMMAND]

Available commands:
  e | enter         Interact with the notes directory
  f | format        Format files with a prose formatter
  h | help          Show this message
  j | journal       Open up todays journal
  k | keybindings   View all fzf window keybindings
  s | search        Start a full-text search

notes also sets a bunch of keybindings within the fzf window for note interactions:

<ctrl-\> Toggle the preview window
<ctrl-c> Exit
<ctrl-d> Delete the selected file
<ctrl-e> Create a new file whose name is the current query string
<ctrl-f> Format the selected file
<ctrl-j> Scroll down the preview window
<ctrl-k> Scroll up the preview window
<ctrl-r> Reload the result buffer
<enter>  Edit the selected file