Skip to content

Installation

riomoo edited this page Apr 8, 2026 · 1 revision

Installation

nt is available in two editions — a Bash script and a Go binary. Both are feature-equivalent and store notes in the same ~/.config/nt directory.


Bash Edition

Requirements: bash 4+, git, sed

chmod +x nt.sh
sudo cp nt.sh /usr/local/bin/nt

Verify the install:

nt help

macOS note: macOS ships with bash 3. Install bash 4+ via Homebrew (brew install bash) or use the Go edition instead.


Go Edition

Requirements: Go 1.21+, git

Using make

make install        # builds and copies binary to /usr/local/bin/nt

Manual build

go build -o nt ./cmd/nt
sudo mv nt /usr/local/bin/nt

Verify

nt help

First Run

On first run nt will automatically create ~/.config/nt and initialise a git repository there. You will see:

✓ Initialised git repo at /home/<you>/.config/nt

No manual setup is required beyond the install steps above.


Uninstall

sudo rm /usr/local/bin/nt
# Optionally remove all notes and history:
rm -rf ~/.config/nt

Clone this wiki locally