This section gets ntropy onto your machine and takes you through the first vault. Install it below, scaffold a vault, and write a note. Then read A day with ntropy, a short tour of how the commands fit together, and keep Commands, the reference table of every command and flag, within reach.
Installation
ntropy is published on crates.io:
cargo install ntropy
Pre-built binaries
Each release ships binaries on the GitHub Releases page for macOS (Apple Silicon and Intel) and Linux (x86_64 and aarch64, statically linked).
Building from source
git clone https://github.com/jakobwesthoff/ntropy.git
cd ntropy
cargo build --release
cargo install --path . # install your working copy onto your PATH
Note
ntropy supports macOS and Linux. Windows is not supported; the reason is in Limitations.
Quick start
# Scaffold a vault (this also seeds a by-tag view)
ntropy init ~/notes
cd ~/notes
# Create a note from a template and open it in your editor
ntropy new My first note
# Open today's daily note (created on first use each day)
ntropy today
# Find and open notes: full query language, fuzzy picker when several match
ntropy search tag:work and not status:done
new stamps the note out of a
Templates and daily notes, and
today has a daily template of its own. search takes an expression in the
Query language; one match
opens in your editor, several open the
The interactive picker.
You never have to tell ntropy which vault you mean from inside one. It finds the vault on its own; the rules are in Finding the vault.