brian-dawn / jot

A fast terminal note taking tool.

jot

Hosted on SourceHut but also hosted on Github for convenience. If you're curious why SourceHut is neat check out this.

Install

If you don't have Rust installed an easy way is to use rustup.

Build and install with:

cargo install --path .

Initialize jot by running:

jot

If you want to customize where the journal files live edit $HOME/.config/jot/config.toml and give it a valid path to your journal path (you'll have to create it for now, absolute paths please).

I like putting my journal in a Syncthing (Dropbox would also work) folder so my config looks like this:

journal_path = "/Users/brian/Sync/jot"

Requirements

Make sure ~/.cargo/bin is in your $PATH or add the following to .bashrc:

source $HOME/.cargo/env

Usage

Notes

Make a note:

jot note

View all notes:

jot notes

Todos

Make a todo:

jot todo

View all todos:

jot todos

Complete a todo (where kw is the id):

jot complete kw

Tags

Any note/todo/reminder can have tags, a tag is just a word preceeded by the @ symbol.

List tags:

jot tags

Other

Dump everything:

jot cat

Reverse stuff:

jot cat --reverse
jot todos -r

Filter any of the view commands by tags:

jot notes -t @music

Grep any of the view commands:

jot todos -g birthday
jot cat -g "foo.*?bar"

Edit a note/todo/reminder (where bt is the id):

jot edit bt

Delete a note/todo/reminder (where 'fq' is the id):

jot delete fq

Start a fuzzy interactive search:

jot search

Configuration

Jot will use your default $EDITOR to determine how notes should be written/edited. To update this, add the following to your .bashrc and update vim to be your desired editor:

export EDITOR='vim'
export VISUAL='vim'

Ideas

• Just have notes and maybe todos. Todos honestly can be tags.
• Allow for titles? Idk maybe, if we can somehow autocomplete tags and titles and create links that could be cool.
• Allow for journal file to be broken apart into separate files.
• Interactive graph traversal
• Custom titles that are the IDs so then it is easy to refer.