Skip to main content

CLI overview

sunset <command> [flags]
CommandPurpose
parse [directory]Scan and document a directory root; defaults to the current directory.
update [path]Reparse changed files incrementally.
languagesList supported language IDs and extensions.
versionPrint the Sunset version.
clean [path]Remove the project's .sunset cache and output.
helpPrint root usage.

--help and --version are also accepted at the root. Commands exit nonzero for unknown commands and parse runs that collect file errors.

Current limitation​

The CLI parse workflow supports directory roots only. Single-file parsing is a current limitation of the CLI; use the public Go API's ParseFile for a single source file.