keepnote
v3.0.0
Published
Simple CLI note-taking tool
Readme
keepnote
Lightning-fast note-taking for the command line
Dead simple. Blazingly fast. Just notes.
Why?
- Search is instant - ripgrep + fzf means you find what you need in milliseconds
- Creating notes is frictionless -
kn "my idea"and you're writing - Opens right where you need - Jumps to the exact line in your editor
- Works everywhere - Linux, macOS, Windows
- No lock-in - Just markdown files in a folder
- Preview while you search - See your notes with syntax highlighting before opening
Installation
npm install -g keepnoteWhat you need
Three excellent CLI tools (you probably already have them):
Install on macOS (Homebrew):
brew install ripgrep fzf batInstall on Windows (Scoop):
scoop install ripgrep fzf batInstall on Linux (Ubuntu/Debian):
apt install ripgrep fzf batUsage
New note:
kn "My note title"Boom. New note created as YYYY-MM-DD_my-note-title.md and opened in your editor.
Find your notes:
knFuzzy search appears. Type to filter. Hit Enter. Done.
Configure:
keepnote configOpens ~/.config/keepnote/config.toml where you can set your notes path and editor:
notePath = "/path/to/your/notes" # default: ~/notes
editor = "code" # default: $EDITOR or vimGet help:
keepnote helpHow it works
- Create:
kn "title"generates a markdown file with date prefix - Search:
knuses ripgrep to index all notes, pipes to fzf for interactive filtering - Preview: bat provides syntax-highlighted preview while browsing
- Open: Selected note opens in your configured editor at the matched line
Credits
Inspired by ripnote by cekrem.
License
MIT
