jot

Highlights • Notes • Installation • Usage • Build from Source • Authors • License

Jot is a CLI alternative for Obsidian built with rust.
While Obsidian is an excellent knowledge management tool, it proves to be overkill when all I want to do is jot down (pun intended) some notes and manage them locally, plus the GUI can often slow things down. Since Obsidian doesn't have a CLI client or an API that can enable the creation of one, I decided to make a fast and lightweight CLI alternative.
Jot is aimed at making note management, that can seem tedious on a GUI, blaaaazingly fast⚡.

Highlights

• Jot is under active development.
• Jot uses files and folders for notes and vaults just like Obsidian.
• Jot is aimed at reducing the time taken to perform tasks, so, each command is a two letter abbreviation of the word(s) that describe it.

Notes

• App data is stored in config and data files in locations generated by the directories crate. It is advised that these files not be messed with, since atm there's no way to automatically fix them.
• App config has two fields: editor & conflict.
  • editor by default is set to nvim and conflict to true.
  • conflict field tells the app if the editor conflicts with it for control over the terminal. Set it to true for editors like nvim and false for editors like notepad.

Installation

With cargo

Run the following command to install jot with cargo:

bash $ cargo install jt

v0.1.0 Executable Download

Jot v0.1.0 (.exe)

Commands

vl

Use this command to create a vault.
This command needs an absolute path (as location for vault) that already exists or it will fail.

Pass in no arguments to get a list of vaults.

Use the -l flag to get vaults' locations.

en

Use this command to enter a vault.

nt

Use this command to create a note in current folder.

op

Use this command to open a note.

fd

Use this command to create a folder in current folder

cd

Use this command to change current folder.

ls

Use this command to print dir tree of the current folder

rm

Remove an item (vl, nt or fd).

rn

Rename an item (vl, nt or fd).

mv

Move an item (vl, nt or fd).

vm

Move an item (nt or fd) to a different vault.

cf

Use this command to get the value of a config field.

Pass in a value along with the above command to set the value of the config field.

Build from Source

Prerequisites

• Git is need to clone the repository on your machine.
• Cargo is needed to compile the app.

Installation & Configuration

Clone the repo and cd into the directory:

bash $ git clone https://github.com/araekiel/jot.git $ cd jot

Run the following command to install dependencies and build/compile the app.

bash $ cargo build

Then run the executable created in target/debug/.

Or, run the app directly:

bash $ cargo run -- *args*

Pass in commands and arguments after '--'.

Authors

• araekiel - Github

License

MIT License | Copyright (c) 2022 Kumar Shashwat