Jottem is both an executable binary that can be run, and a library that can be used in Rust programs.
Installing the command-line executable
Assuming you have Rust/Cargo installed , run this command in a terminal:
cargo install jottem
It will make the jottem command available in your PATH if you've allowed the PATH to be modified when installing Rust . cargo uninstall jottem uninstalls.
Adding jottem library as a dependency
Run this command in a terminal, in your project's directory:
cargo add jottem
To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:
jottem = "0.1.8"
The jottem library will be automatically available globally.
Read the jottem library documentation .
Back to the crate overview .
Readme
A lean, low friction terminal app for managing markdown notes.
Installation
With Cargo via Crates.io
If you have Rust installed, Jottem can be installed directly from Crates.io
cargo install jottem
Build locally
If you wish, you can build Jottem yourself
git clone https://github.com/dogue/jottem.git
cd jottem
cargo install -- path .
Arch User Repository
Jottem is also available in the AUR with the jottem-bin package
yay - S jottem- bin
Quick Start
# create a note
jottem create my_note
# edit a note
jottem edit my_note
# delete a note
jottem delete my_note
# find a note
jottem find - - all
You can find a more in-depth explanation of the available commands and their options in the wiki .
Key Features
Fast: Jottem uses RocksDB to index notes for quick retrieval and search.
Flexible: Optionally use subdirectories to organize your notes.
Tagging: Categorize notes easily with a simple tagging system.
Agnostic: Jottem uses your $ EDITOR variable to edit notes in your preferred app.
License
MIT