mirror of
https://github.com/KeygraphHQ/shannon.git
synced 2026-06-30 02:25:39 +02:00
george-keygraph
10b26355be
Replace the README with the marketing-reviewed version and bring the project onto one consistent naming scheme: - "Shannon Lite" -> "Shannon" (the open-source CLI is just Shannon) - "Shannon Pro" -> "Keygraph" (the commercial platform) - Rename docs/shannon-pro.md -> docs/keygraph-platform.md and fix the internal link, matching the README's link target. - Regenerate llms.txt and llms-full.txt from the updated README and docs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1.5 KiB
1.5 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.
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