@any-nav/cli
v0.2.0
Published
Any-Nav CLI integration adapter (L0): discovers config, materializes generated navigation fragments into agent files (AGENTS.md and other registered formats). Owns all disk writes and exit codes.
Readme
@any-nav/cli
Point any-nav at any Markdown folder. No more hand-maintained index files.
The Any-Nav CLI integration adapter: it discovers config, answers navigation
queries, and materializes generated listings into marked file sections. This
package owns all disk writes and exit codes — the SDK (@any-nav/core) it
wraps is read-only.
Install
npm install -g @any-nav/cliUsage
any-nav init # scaffold an any-nav.toml in the current folder
any-nav list [path] # render the navigation listing for a folder
any-nav list --depth N # bound the walk depth
any-nav list --write # materialize the listing into the marked section
any-nav list --json # machine face: pure JSON (routing projection) on stdout
any-nav help [command] # command help, plus non-command help topics- Empty results are legal answers (
exit 0) — this is a data-presentation tool, not a filter. - Exit ladder:
0success (including rendered help/version),1runtime failure,2usage error. --jsonkeeps stdout a pure JSON stream: maintainer-class diagnostics go to stderr, consumer-facing notes ride the listing itself.
Config
any-nav.toml — states only exceptions; every key defaults:
local— curation list: paths expanded into the default listing.budget— the context-budget guard (warns, never silently collapses).scan— scan boundary policy, additive over the engine's built-in floor.
list walks up from the target folder for the nearest any-nav.toml;
without one it lists on pure defaults.
License
MIT
