/ntbk

CLI for managing notes

Primary LanguageRustMIT LicenseMIT

ntbk

ntbk is a terminal notebook manager written in rust.

Installation

Clone this repository.

git clone git@github.com:maaslalani/ntbk.git

Install ntbk with cargo.

cargo install --path ntbk

Configuration

Set the NOTES_DIRECTORY variable to your notes ENV. (default is ~/notes).

export NOTES_DIRECTORY="/Users/maas/notes/"

Usage

ntbk find   <pattern>  - Find notes by path
ntbk grep   <pattern>  - Search through notes content
ntbk help              - Print this usage information
ntbk list              - List all notes
ntbk new    <name>     - Create a new note with <name>
ntbk open   <name>     - Open a note
ntbk remove <name>     - Remove a note
ntbk show   <name>     - Show a note's content

Contributing

Pull requests are welcome.

License

MIT