CLI reference
This file is generated from bin/knossos help; edit the application help, not this file.
text
Knossos architecture intelligence
Usage:
knossos [path] [--editor=<command>] [--theme=dark|light]
(the pane in this terminal; needs Node 24+; a directory named like a
command is written ./name)
knossos usage
knossos version [--json]
knossos doctor [--db=PATH] [--json]
knossos list-projects [--limit=N] [--offset=N] [--include-roots]
[--db=PATH] [--json]
knossos list-snapshots <path|project-id> [--limit=N] [--offset=N] [--json]
knossos snapshot-diff <path|project-id> <from-snapshot> [to-snapshot]
[--max-changes=N] [--json]
knossos quality-gate <path|project-id> <baseline-snapshot> --budgets=FILE
[--policies=FILE] [--sarif] [--propose-baseline] [--json]
knossos architecture-trends <path|project-id> [--limit=N]
[--release-from=SNAPSHOT] [--json]
knossos remove-project <project-id> [--execute] [--db=PATH] [--json]
knossos move-project <old-root|project-id> <new-root> [--execute] [--db=PATH]
[--json]
knossos export-notes [<folder>] [--file=PATH] [--db=PATH] [--json]
knossos import-notes [<folder>] [--file=PATH] [--execute] [--db=PATH] [--json]
knossos cleanup-stale-scans <project-id> [--older-than-hours=N]
[--execute] [--db=PATH] [--json]
knossos maintain-database <integrity|checkpoint|optimize|vacuum|backup>
[--backup-name=NAME.sqlite] [--execute] [--db=PATH]
[--json]
knossos scan <path> [--mode=auto|full|incremental] [--name=NAME]
[--boundary=NAME:path:PREFIX] [--snapshot-retention=N]
[--max-files=N] [--max-file-bytes=N]
[--worker-timeout-ms=N]
[--worker-memory-mb=N] [--no-enrichers]
[--db=PATH] [--json]
knossos watch <path> [--poll-ms=N] [--debounce-ms=N] [--max-queue=N]
[--shared] [--db=PATH] [--json]
knossos export-bundle <project-id> --output=FILE
[--redaction=none|paths|strict] [--db=PATH] [--json]
knossos import-bundle <file> [--name=NAME] [--db=PATH] [--json]
knossos find-component <path|project-id> <name> [--limit=N] [--db=PATH] [--json]
knossos inspect-component <path|project-id> <component> [--max-relationships=N]
[--max-children=N] [--min-confidence=LEVEL] [--json]
knossos list-usages <path|project-id> <symbol> [--edge-kind=KIND]
[--min-confidence=LEVEL] [--limit=N] [--exclude-tests]
[--json]
knossos architecture-summary <path|project-id> [--limit=N] [--db=PATH] [--json]
knossos file-metrics <path|project-id> [--path=SUBSTR] [--language=LANG] [--sort-by=path|line_count] [--order=asc|desc] [--limit=N] [--offset=N] [--json]
knossos untested-code <path|project-id> [--granularity=files|components] [--path=PREFIX]
[--limit=N] [--offset=N] [--max-nodes=N] [--timeout-ms=N] [--json]
knossos creation-brief <path|project-id> <file> [--json]
knossos explain-flow <path|project-id> <from> <to> [--max-depth=N] [--max-paths=N]
[--edge-kind=KIND] [--min-confidence=LEVEL] [--timeout-ms=N]
[--both-directions] [--profile=NAME] [--json]
knossos impact-analysis <path|project-id> <symbol> [--max-depth=N] [--limit=N]
[--edge-kind=KIND] [--min-confidence=LEVEL] [--timeout-ms=N]
[--seed-members=false] [--rings] [--json]
knossos dependency-cycles <path|project-id> [--edge-kind=KIND] [--limit=N]
[--min-confidence=LEVEL] [--max-nodes=N]
[--max-edges=N] [--timeout-ms=N]
[--include-self-loops] [--within-type]
[--include-facades] [--json]
knossos architecture-health <path|project-id> [--edge-kind=KIND] [--limit=N]
[--min-confidence=LEVEL] [--max-nodes=N]
[--max-edges=N] [--timeout-ms=N] [--include-external]
[--include-tests] [--candidate-confidence=LEVEL]
[--candidate-offset=N] [--candidate-limit=N]
[--path-prefix=PATH] [--include-annotated]
[--include-examples] [--candidates-only]
[--include-untyped-receiver]
[--candidate-timeout=MS] [--json]
knossos dead-code <path|project-id> [--reachability=unreferenced|test-only]
[--candidate-timeout=MS] [--db=PATH] [--json]
knossos diagnostics <path|project-id> [--severity=error|warning|info]
[--path=PREFIX] [--db=PATH] [--json]
knossos policies <path|project-id> [--db=PATH] [--json]
knossos check-architecture <path|project-id> [--policies=FILE] [--limit=N]
[--min-confidence=LEVEL] [--max-edges=N]
[--timeout-ms=N] [--json]
knossos suggest-location <path|project-id> <feature-description> [--limit=N]
[--max-members=N] [--max-edges=N]
[--timeout-ms=N] [--ranking-mode=MODE] [--json]
knossos change-impact <path|project-id> <symbol> [--since-days=N]
[--max-commits=N] [--max-depth=N] [--limit=N]
[--edge-kind=KIND] [--min-confidence=LEVEL]
[--timeout-ms=N] [--json]
knossos changed-files-impact <path|project-id> [FILE...] [--working-tree]
[--base-ref=REF] [--max-depth=N] [--limit=N]
[--edge-kind=KIND] [--min-confidence=LEVEL]
[--timeout-ms=N] [--json]
knossos test-impact <path|project-id> [FILE...] [--working-tree]
[--base-ref=REF] [--max-depth=N] [--limit=N]
[--edge-kind=KIND] [--min-confidence=LEVEL]
[--timeout-ms=N] [--json]
knossos review-diff <path|project-id> [FILE...] [--base-ref=REF]
[--policies=FILE] [--budgets=FILE]
[--baseline-snapshot=SNAPSHOT] [--max-depth=N]
[--limit=N] [--min-confidence=LEVEL] [--timeout-ms=N]
[--json]
knossos architecture-context <path|project-id> [FILE...] [--task=TEXT]
[--max-chars=N] [--timeout-ms=N]
[--include-source] [--json]
knossos export-diagram <path|project-id> [--format=mermaid|plantuml]
[--boundary=ID_OR_NAME] [--edge-kind=KIND]
[--direction=LR|TB] [--max-nodes=N] [--max-edges=N]
[--min-confidence=LEVEL] [--json]
knossos export-agent-brief <path|project-id> [--max-chars=N] [--out=FILE] [--json]
knossos session-brief [path] [--db=FILE] [--json]
knossos turn-brief [path] [--files=PATH]... [--policies=FILE] [--no-policies]
[--since=SNAPSHOT] [--reuse-scan] [--db=FILE] [--json]
knossos rescan [path] [--db=FILE] [--json]
knossos dashboard [path] [--fan-in-threshold=N] [--boundaries=N] [--db=FILE] [--json]
knossos component-detail [path] <name> [--db=FILE] [--json]
knossos file-detail <file> [--db=FILE] [--json]
knossos session-changes [path] (--since=SNAPSHOT | --working-tree) [--db=FILE] [--json]
knossos boundary-couplings [path] --from=BOUNDARY --to=BOUNDARY [--db=FILE] [--json]
knossos graph-search [path] --query=TEXT [--db=FILE] [--json]
knossos file-context <file> [--db=FILE] [--json]
knossos branch-diff [path] [--db=FILE] [--json]
knossos churn [path] [--db=FILE] [--json]
knossos blast-radius [path] --component=NAME [--db=FILE] [--json]
knossos path-between [path] --from=NAME --to=NAME [--db=FILE] [--json]
knossos annotate [path] --component=NAME [--kind=KIND] [--value=TEXT] [--remove]
[--author=user|model] [--execute] [--db=FILE] [--json]
knossos notes [path] [--filter=all|yours|model|stale|missing|flagged] [--text=TEXT]
[--db=FILE] [--json]
knossos note-adopt [path] --component=NAME [--value=TEXT] [--execute] [--db=FILE] [--json]
knossos note-move [path] --component=NAME --to=NAME [--kind=KIND] [--author=user|model]
[--execute] [--db=FILE] [--json]
knossos note-check [path] --component=NAME [--value=TEXT] [--remove] [--execute]
[--db=FILE] [--json]
knossos note-confirm [path] --component=NAME [--execute] [--db=FILE] [--json]
knossos notes-export [path] [--file=PATH] [--db=FILE] [--json]
knossos notes-import [path] [--file=PATH] [--execute] [--expect=SHA256] [--db=FILE] [--json]
knossos session-head [path] [--json]
knossos session-diff [path] --rev=SHA --file=PATH [--json]
knossos install-agent-plugin [--scope=user] [--data-dir=DIR] [--plugin-dir=DIR] [--bin=PATH]
[--no-register] [--execute] [--json]
knossos install-agent-plugin --out=DIR --data=HOSTPATH [--image=NAME] [--json]
(--db=PATH is accepted by both and has no effect)
knossos list-boundaries <path|project-id> [--source=explicit|inferred] [--limit=N]
[--offset=N] [--json]
knossos search-architecture <path|project-id> <query> [--kind=KIND] [--role=ROLE]
[--boundary=ID] [--confidence=LEVEL] [--files] [--limit=N]
[--offset=N] [--json]
knossos annotate-component <path|project-id> <component> <kind> [value]
[--remove] [--replace] [--confirm] [--move-to=NAME]
[--evidence=PATH]... [--execute] [--db=PATH] [--json]
knossos list-annotations <path|project-id> [--component=NAME] [--kind=KIND]
[--limit=N] [--offset=N] [--db=PATH] [--json]
knossos serve [--allow-root=PATH]... [--db=PATH]
(roots also come from KNOSSOS_ALLOWED_ROOTS and the roots
file beside the database, re-read on every request)
knossos allow-root <path> [--execute] [--db=FILE] [--json]
knossos claim <path> [--execute] [--db=FILE] [--json]
(prints one status: added, would-add, present, ask for a folder too
broad to allow unasked, fixed for a container, or error with the
reason; every status exits 0, because the hooks that call it turn
a nonzero exit into silence)
knossos record-scan-failure <path> --class=C [--signal=N] [--started-by=S] [--db=FILE]
(for the hook wrappers: keeps a scan that was killed or timed out in
scan-failures.jsonl beside the database, where doctor reads it; C is
killed, lock, worker, other, timed-out or brief-timeout)
knossos autostart <path> [--set=on|off] [--db=FILE] [--json]
knossos self-update [--check [--quiet]] [--rollback] [--version=V] [--json]
(an installed release only: fetches the newest release, checks it
against its SHA256SUMS, switches to it and keeps the previous one
for --rollback; --check says whether a newer one exists and exits
10 when it does; --quiet prints nothing and only refreshes the cached
answer, at most once a day; a source checkout is updated with git pull)
knossos enricher list [--db=FILE] [--json]
knossos enricher add <name> [--timeout=N] [--env=NAME=VALUE]... [--kinds=a,b]
[--replace] [--db=FILE] [--json] -- <command> [args...]
knossos enricher remove <name> [--db=FILE] [--json]
knossos web [path] [--port=N] [--no-open] [--editor=<command>]
(the pane in a browser tab; runs until Ctrl-C, needs Node 24+)
Docker supplies PHP, Node, Composer, and SQLite; mount source read-only at an
allowed path and graph data read-write at /data.