Skip to main content

Sunset

Sunset is a Go codebase indexer. It scans a project for supported source files, parses them with tree-sitter, and writes structured Markdown with YAML frontmatter for code review, documentation, or AI-assisted exploration.

The CLI is the primary product interface. Start with Installation, then run the Quick start.

What Sunset produces​

  • A project index.md with file, language, function, and type totals.
  • One Markdown document per source file under .sunset/output/files.
  • Summary output for functions, types, imports, constants, and doc comments.
  • Optional full concrete syntax tree output for parser-level inspection.

Sunset currently supports Go, JavaScript, TypeScript, and Python. The scanner uses .gitignore, built-in directory exclusions, and explicit glob patterns to choose files. See Concepts overview for the model and Limitations for important boundaries.