Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

19 Commits

Repository files navigation

note

Command-line tool for creating and browsing notes using standard input and fzy.

Requirements

  • fzy at /opt/homebrew/bin/fzy

Installation

Run the install script:

./install.sh

This creates a symbolic link at /usr/local/bin/note.

Manual install:

chmod +x note.sh
sudo ln -s "$(pwd)/note.sh" /usr/local/bin/note

Usage

Add a note interactively:

./note.sh -a "This is the title of a note"

The interactive prompt reads your input line-by-line where you can:

  • Edit the current line using standard keys (Backspace, Delete, Left/Right arrows).
  • Use standard line editing shortcuts: Ctrl+A (Home), Ctrl+E (End), Ctrl+U (clear to start of line), and Ctrl+K (clear to end of line).
  • Press Enter to move to the next line.

Save and exit with any of these:

  • Type a line with only . and press Enter
  • Type a line with only EOF and press Enter
  • Press Ctrl+D from anywhere to save the note immediately

Save a note directly without typing interactively:

./note.sh -a -m "Remember to call John""Reminder"

Save from a file:

./note.sh -a -f ./draft.txt "Meeting notes"

Save using your editor ($EDITOR, default nano):

./note.sh -a -e "Meeting notes"

Pipe content into the script:

cat notes.md | ./note.sh -a "Meeting notes"

List and search notes with fzy (with the latest note on top of the list), then print the selected note to stdout (default behavior when no arguments are provided):

./note.sh

Delete a note interactively with fzy (displays the selected note and prompts for confirmation before deletion):

./note.sh -D

Shortcut to add a note (same as -a):

./note.sh "This is the title of a note"

Notes preserve multiple lines and empty lines exactly as written. Any HTTP/HTTPS URL links in the note are automatically highlighted as blue, underlined hyperlinks, allowing you to open them directly in your default web browser (like Safari) by clicking (or Cmd-clicking) them.

Notes are saved to ~/notes.txt, one line per note:

2026-07-04 12:59 : Meeting notes : (1. First step\n2. Second step\n\n3. Third step)

Multi-line content is stored with \n inside the parentheses. Older note formats are still supported when listing.

About

note

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages