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/
      06.md

Prerequisites

• Rust (includes cargo)

Build the app

cargo build --release

Optional: add an alias

alias nost="RUST_LOG=warn /path/to/nost/target/release/nost"

Configure the app

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

not_path="/path/to/your/notes"
language="fr"

Create a note

cargo run new

Or

cargo run n

Work sessions (WIP)

Begin a work session:

cargo run start-work

Or

cargo run sw

End a work session:

cargo run end-work

Or

cargo run ew

Display work stats:

cargo run work-stats

Or

cargo run ws

Work plugin configuration

For computing work stats, add some env vars:

export NOST_WORK_SALARY=0
export NOST_WORK_CURRENCY=EUR

Development

Unit tests:

cargo test

Style:

cargo clippy --verbose -- -D warnings

Linter:

cargo fmt -- --check