Usage

Usage

All commands follow the pattern nt <command> [arguments].
Running nt or nt help with no arguments prints a summary.

---

Command Reference

nt new <name>

Create a new note. Opens the note in $EDITOR (defaults to nano) after creating it with a timestamp header. Commits automatically on save.

nt new meeting
nt new projects/roadmap      # subdirectory — created automatically

---

nt edit <name>

Open an existing note in $EDITOR. Commits automatically on save.

nt edit meeting

---

nt show <name>

Render a note to the terminal with colour-highlighted Markdown — headings, bold, italic, checkboxes, links, and tables.

Aliases: cat, view

nt show meeting
nt cat meeting

---

nt list

List all notes in ~/.config/nt, including those in subdirectories.

Alias: ls

nt list
nt ls

Example output:

Notes in /home/you/.config/nt

  • ideas
  • meeting
  • projects/roadmap

---

nt delete <name>

Delete a note after a confirmation prompt. Commits the deletion.

Aliases: rm, remove

nt delete meeting

---

nt search <query>

Case-insensitive full-text search across all notes. Shows the note name and up to three matching lines per note.

Aliases: grep, find

nt search "Alice"
nt search TODO

---

nt log

Display the git commit history of the notes repository in a compact graph format.

nt log

---

nt git [args]

Pass any git command directly to the notes repository. Useful for setting up remotes, pushing, pulling, diffing, and more.

nt git remote add origin git@github.com:you/notes.git
nt git push -u origin main
nt git diff HEAD~1

---

Exit Codes

Code	Meaning
0	Success
1	Error (message printed to stderr)