Skip to content

Latest commit

 

History

History

README.md

Examples

Copy-paste walkthroughs for common Repowise setups. Each example is a self-contained README under examples/<name>/.

Available examples

Example What it shows
codex/ Codex CLI setup: repowise init --codex, smoke checks, local plugin install
dead-code/ repowise dead-code — unused exports and cleanup candidates (no LLM key)
decisions/ repowise decision list/health/confirm — architectural records (no LLM key)
distill/ distill / expand / saved — compress command output (no LLM key)
health-coverage/ Code health, coverage ingest, and impacted-tests (no LLM key)
hooks-sync/ hook install + watch — keep the index fresh (no LLM key)
opencode/ OpenCode as the LLM provider for wiki generation
risk/ repowise risk change / PR defect scoring (no LLM key)
search/ repowise search fulltext / symbol / semantic wiki lookup
security-scan/ Working-tree security signals + OSS security scan --history (no LLM key)
structurizr-export/ export --format structurizr fragment vs standalone (no LLM key)
wiki-export/ export markdown / html / json wiki pages (no LLM key)

Conventions

  • One directory per topic: examples/<name>/README.md.
  • Prefer real CLI commands that match docs/reference/CLI_REFERENCE.md.
  • Link deeper docs instead of duplicating them.
  • Keep smoke checks short and runnable without inventing fake APIs.

Related docs