mirror of
https://github.com/KeygraphHQ/shannon.git
synced 2026-07-05 12:47:57 +02:00
ezl-keygraph
00e56455df
* feat: surface report at run root and nest run internals under .shannon * feat: use plain-language wording in user-facing terminal messages * feat(cli): guide users to watch scan progress and surface report path on start * docs: sync run-folder layout and CLI wording across docs and comments * feat(cli): add version command reporting package version or git SHA * feat(cli): detect TTY for interactive prompts, color, and progress output * docs: document --yes flag, version command, and tty module * fix(cli): FORCE_COLOR precedence and plain uninstall --yes output * fix(cli): respect empty NO_COLOR * fix(cli): let NO_COLOR take precedence over FORCE_COLOR * docs: mark claude-code-router integration as removed
1.7 KiB
1.7 KiB
Workspaces and Resuming
Shannon uses workspaces to store scan state, logs, prompts, and deliverables. Workspaces allow interrupted or failed runs to resume without re-running completed agents.
How Workspaces Work
- Every run creates a workspace.
- Auto-named workspaces use the target hostname and a session ID, such as
example-com_shannon-1771007534808. npxmode stores workspaces in~/.shannon/workspaces/.- Source-build mode stores workspaces in
./workspaces/. - Use
-w <name>to give a run a custom name. - To resume a run, pass the same workspace name with
-w. - Each agent's progress is checkpointed so resumed runs can skip completed work.
- The final report is surfaced at the workspace root as
Security-Assessment-Report.md. Run internals — deliverables, logs, prompts, and session state — live under a hidden.shannon/directory.
Note
The URL must match the original workspace URL when resuming. Shannon rejects mismatched URLs to prevent cross-target contamination.
Examples
Start with a named workspace:
npx @keygraph/shannon start -u https://example.com -r /path/to/repo -w my-audit
Resume the same workspace:
npx @keygraph/shannon start -u https://example.com -r /path/to/repo -w my-audit
Resume an auto-named workspace:
npx @keygraph/shannon start -u https://example.com -r /path/to/repo -w example-com_shannon-1771007534808
List all workspaces:
npx @keygraph/shannon workspaces
Source-build equivalents:
./shannon start -u https://example.com -r /path/to/repo -w my-audit
./shannon start -u https://example.com -r /path/to/repo -w example-com_shannon-1771007534808
./shannon workspaces