Skip to content

Knossos documentation ​

Each page answers one question. Every page describes behaviour at the code it ships with, and anything a scan cannot prove is labelled as heuristic, bounded or unsupported on the page that covers it. The project README is the short version.

Get started ​

  • Installation: how do I install Knossos from a release, a checkout or Docker, register it with Claude Code, and what goes wrong?
  • First scan: how do I scan a project, check the result, and what does an answer look like?
  • Project configuration: how do I tell Knossos what to skip, where the boundaries are, and which rules and budgets to check?

Claude Code ​

  • The plugin: how do I install, point, update and remove the Claude Code plugin?
  • The pane: how do I open the pane, read its header and layouts, and which keys and settings drive it?
  • The band: what does the line above the prompt say after a turn?
  • The tabs: what does each of the nine tabs show?
  • Notes on components: how do I read, write, confirm and find the notes, yours and the model's?
  • Details, routes and the finder: what opens from a row, and how do I find a component by name?
  • Live updates: how do the pane and the band follow the code, and what shows before there is a graph?
  • Messages for the model: what does the mod tell the model, when, and in which words?
  • Session brief: what does a session see when it starts, and how is each verdict chosen?
  • The routing skill: which questions does the skill send to the graph, and which does it keep away?
  • The pane in a browser: how do I open the pane in a browser tab with knossos web, and what does it leave out?
  • The pane in a terminal: how do I open the pane fullscreen in a terminal with knossos, and how does it share a server?

Agents ​

  • Codex and other MCP clients: how do I register Knossos with Codex or another MCP client, and add the routing skill to Codex?
  • Agent integration: which tools orient an agent before it greps, how does it get an evidence bundle for one task, and how does it record a judgment for later sessions?

Concepts ​

Guides ​

What to ask the graph for one kind of task, through the MCP tools or the CLI.

  • Finding components: how do I find a project, a component, its relations and every place a symbol is used?
  • Structure analysis: what depends on this, how does A reach B, where are the cycles and hubs, which code does no test reach, and where does new code belong?
  • Dead-code candidates: what does architecture_health report as unreferenced or reached only by tests, and what does it exclude first?
  • Reviewing a change: what does this diff put at risk, and which tests reach it?
  • Declared rules and budgets: how do I make architectural intent something a build can fail on?
  • Scan history: what changed between two scans, and how have the metrics moved?

Languages ​

  • PHP: how does the PHP worker type a call, and how does it match names written in another case?
  • PHP and Laravel: what do the Laravel and Livewire enrichers add to a PHP scan?
  • PHP and Symfony: what does the Symfony enricher add to a PHP scan?
  • TypeScript and JavaScript: what does the TypeScript worker extract, from which files and frameworks?
  • Python: what does the Python worker extract, and which frameworks does it recognise?
  • Rust: what does the Rust worker extract, and where does it stop?

Reference ​

Generated pages are rebuilt by php tools/generate-reference.php. Edit the help text and schemas they come from, never the Markdown.

Operate ​

Contribute ​

Decisions and examples ​