Reference

Reference material โ€” this section is autogenerated into the sidebar.

  • Example Reference โ€” A starter reference page.
  • Git diffs and logs โ€” Inject working-tree diffs, branch diffs, branch logs, and per-file changed content into the prompt with gnaw's git flags.
  • MCP server โ€” The gnaw-mcp server: transport, the GNAW_MCP_ROOT confinement model, the extract and estimate tools, and what isn't exposed yet.
  • Output formats โ€” The --output-format flag, gnaw's Markdown and XML structures, and the related rendering flags.
  • Reading paths from stdin โ€” When gnaw reads a path list from stdin, how those paths are resolved, and how stdin mode interacts with filtering, templates, and the git flags.
  • Secret scanning โ€” The --secret-scan policies, the built-in detection rules, path allowlisting, and the .gnawconfig keys.
  • Shell completion โ€” How gnaw's dynamic completion is installed per shell and what it completes.
  • Timing and performance โ€” Use --timing to print how long a run took and a per-stage breakdown of where the time went.
  • Token map โ€” Print a token-weighted tree of the repo to find exactly what's inflating your prompt.
  • TUI keymap โ€” Every key binding in the gnaw TUI: modes, global shortcuts, the command line, and per-tab keys.