Quick start

Run Sunset against a project directory and inspect the generated Markdown. This example uses a temporary project so it does not modify the repository being documented.

mkdir -p /tmp/sunset-example
printf 'package main\n\nfunc main() {}\n' > /tmp/sunset-example/main.go
sunset parse /tmp/sunset-example

The command should exit successfully and create:

/tmp/sunset-example/.sunset/output/index.md
/tmp/sunset-example/.sunset/output/files/main.go.md
/tmp/sunset-example/.sunset/cache/cache.json

The per-file document contains YAML frontmatter followed by a summary with the detected language, functions, types, imports, constants, and nearby documentation comments. Use --detail full when the complete concrete syntax tree is more useful than the summary.

For the next run, use sunset update /tmp/sunset-example to reuse the cache. The default parse loads and saves the cache, so the second command can skip unchanged files.

To deliberately bypass incremental state, run a separate parse with:

sunset parse --no-cache /tmp/sunset-example

--no-cache parses the discovered files without loading or saving .sunset/cache/cache.json; it is not the setup step for an update workflow. See Core workflow and the CLI reference for the distinction between a fresh parse and an incremental update.