Skip to main content

Parse and update

parse

sunset parse <path> [flags]

The path may be a directory or a file according to the CLI help, but directory roots are the reliable engine workflow. An omitted path means ..

FlagDefaultBehavior
--output<path>/.sunset/outputWrite generated Markdown elsewhere.
--detailsummarysummary extracts declarations; full renders the CST.
--excludeemptyComma-separated filename or relative-path patterns.
--concurrencyNumCPULimit concurrent parser work when positive.
--no-cachefalseParse all discovered files without loading or saving cache state.
--max-depth0Limit full-CST depth; zero is unlimited.
--quietfalseSuppress normal progress and result output.

The command exits non-zero for an invalid path, an engine error, or one or more per-file errors.

update

sunset update [path] [flags]

update enables the cache, compares SHA-256 content hashes, and parses only new or changed files. It always uses summary mode. Its flags are --output, --exclude, --concurrency, and --quiet; it does not expose --detail, --no-cache, or --max-depth.

Choosing a command

Use parse for an initial index or a deliberate full rebuild. Use update for the normal incremental workflow. Use parse --no-cache when cache state should be ignored and not rewritten.