Documentation
¶
Overview ¶
Command nt is a terminal task & note manager that stores data as plain files (todo.txt tasks + markdown notes) so editors, grep, git, and AI agents can read and write it directly. See SPEC.md for the design.
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
aisync
Package aisync mirrors a Claude Code session's TodoWrite list into the nt store (SPEC §8, §10).
|
Package aisync mirrors a Claude Code session's TodoWrite list into the nt store (SPEC §8, §10). |
|
cli
Package cli implements nt's command-line interface.
|
Package cli implements nt's command-line interface. |
|
dateparse
Package dateparse parses the human date and priority inputs nt accepts on the CLI and in the TUI (SPEC §7.3), kept in one place so both surfaces agree.
|
Package dateparse parses the human date and priority inputs nt accepts on the CLI and in the TUI (SPEC §7.3), kept in one place so both surfaces agree. |
|
links
Package links implements the unified cross-item linking model (SPEC §5.1): a single [[target]] syntax that resolves to a note (by slug, title, or id) or a task (by ULID / short prefix), plus backlinks computed on demand by scanning files — no stored index.
|
Package links implements the unified cross-item linking model (SPEC §5.1): a single [[target]] syntax that resolves to a note (by slug, title, or id) or a task (by ULID / short prefix), plus backlinks computed on demand by scanning files — no stored index. |
|
lock
Package lock provides an advisory file lock around the critical section that mutates tasks.txt (SPEC §6.4).
|
Package lock provides an advisory file lock around the critical section that mutates tasks.txt (SPEC §6.4). |
|
mcp
Package mcp serves nt over the Model Context Protocol (stdio, JSON-RPC 2.0), so an agent uses typed tools (nt_ready, nt_add, …) instead of constructing CLI shell strings.
|
Package mcp serves nt over the Model Context Protocol (stdio, JSON-RPC 2.0), so an agent uses typed tools (nt_ready, nt_add, …) instead of constructing CLI shell strings. |
|
mutate
Package mutate is the single ULID-keyed mutation engine shared by the CLI and (later) the TUI, implementing the write contract from SPEC §6.1–6.3.
|
Package mutate is the single ULID-keyed mutation engine shared by the CLI and (later) the TUI, implementing the write contract from SPEC §6.1–6.3. |
|
note
Package note implements nt's markdown notes with light YAML frontmatter (SPEC §5).
|
Package note implements nt's markdown notes with light YAML frontmatter (SPEC §5). |
|
search
Package search implements files-only search (SPEC §7.1): ripgrep when a real rg binary is on PATH, otherwise a built-in walker.
|
Package search implements files-only search (SPEC §7.1): ripgrep when a real rg binary is on PATH, otherwise a built-in walker. |
|
store
Package store resolves the nt data directory ($NT_DIR) and the paths of the files within it.
|
Package store resolves the nt data directory ($NT_DIR) and the paths of the files within it. |
|
task
Package task implements nt's todo.txt task model with the lossless round-trip guarantee from SPEC §4: a file is parsed into an ordered list of nodes (each a parsed task or a preserved raw line), and an unmodified line is re-emitted byte-for-byte.
|
Package task implements nt's todo.txt task model with the lossless round-trip guarantee from SPEC §4: a file is parsed into an ordered list of nodes (each a parsed task or a preserved raw line), and an unmodified line is re-emitted byte-for-byte. |
|
tui
Package tui implements nt's terminal UI (SPEC §12) with Bubble Tea.
|
Package tui implements nt's terminal UI (SPEC §12) with Bubble Tea. |
|
ulid
Package ulid generates ULIDs (Universally Unique Lexicographically Sortable IDs) with zero external dependencies.
|
Package ulid generates ULIDs (Universally Unique Lexicographically Sortable IDs) with zero external dependencies. |
|
undo
Package undo implements the append-only transaction journal from SPEC §6.3.
|
Package undo implements the append-only transaction journal from SPEC §6.3. |
|
web
Package web is the HTTP adapter: a localhost notes viewer (`nt web`).
|
Package web is the HTTP adapter: a localhost notes viewer (`nt web`). |
Click to show internal directories.
Click to hide internal directories.





