Skip to main content

CLI overview

The sunset executable indexes a project directory into Markdown. It is a local command with no service endpoint or authentication flow.

Command map

CommandPurpose
sunset parse [path]Scan and parse supported files, then write output.
sunset update [path]Re-parse changed files using the cache and summary output.
sunset languagesList registered language IDs and extensions.
sunset versionPrint the resolved Sunset version.
sunset clean [path]Remove the .sunset cache and output directory.
sunset helpPrint top-level usage.

An omitted path is .. Root --help/-h prints usage, and root --version/-v prints the version. See Parse and update for the command-specific flags and Configuration reference for scanner behavior.

Result directories

The default output is <path>/.sunset/output. It contains index.md and a files/ directory. Cache-enabled commands store file hashes at <path>/.sunset/cache/cache.json; --no-cache does not load or save that file.