Skip to content
c4arl0sPublic

About

note

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

30 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

note

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

Requirements

  • fzy at /opt/homebrew/bin/fzy
  • glow at /opt/homebrew/bin/glow (optional, for rendering markdown notes)

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 opens vim where you can write your note with full text-editing and navigation capabilities.

Save and exit vim by saving the file and quitting (:wq or :x or ZZ).

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 (displays 25 rows by default, configurable via FZY_LINES, 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

List and search notes with fzy, then copy the note to the clipboard in addition to displaying it to standard output:

./note.sh -c

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

./note.sh -D

Edit a note interactively with fzy (opens the selected note in vim for editing, and displays the updated note when finished):

./note.sh -E

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 inside ~/notes/ as separate .txt files. The file name is generated automatically based on the note's title (using lowercase and hyphens).

Inside each note file, metadata headers are stored at the top:

Date: 2026-07-04 12:59
Title: Meeting notes

1. First step
2. Second step

3. Third step

Testing

Run the automated test suite:

./test.sh

About

note

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages