Nost

Nost is a markdown-based note generator that adheres to the NOT format.

Whenever you need to take notes, Nost helps you create files following the structure: year/month/week number/day number.

For example, if you add a note on the 6th of June 2025:

  2025/
    06/
      1/
      03.md

Create a not

cargo run not

Or

cargo run n

(WIP) Use not for working

Begin a work session:

cargo run start-work

Or

cargo run sw

End a work session:

cargo run end-work

Or

cargo run ew

For now, the data is only annotated, but these annotations are not yet used or processed.

Test

Unit tests:

cargo test

Style:

cargo clippy --verbose -- -D warnings

Linter:

cargo fmt -- --check

Configure the app

Copy config.toml.dist into config.toml and update the values. For example:

not_path="/home/gaetan/not"
language="fr"

Build the app

Build the app with cargo

cargo build --release

Optional: add an alias

alias nost="RUST_LOG=warn /your/path/for/nost-not/nost/target/release/nost"

Work plugin

For computing work stats, add some env vars:

export NOST_WORK_SALARY=0
export NOST_WORK_CURRENCY=EUR