mirror of
https://github.com/KeygraphHQ/shannon.git
synced 2026-09-13 21:49:04 +02:00
ajmallesh
2469e6deac
Add the final Mantis and Pi notices, license copies, acknowledgements, and residual copyright updates. Update the README, maintained documentation, contributor guidance, and hand-maintained mirrors to describe Agentic SAST, reconciliation, the Miscellaneous lane, current CLI behavior, and the final release contract. Correct stale workspace and container guidance and annotate long-standing internals for maintainers.
52 lines
1.7 KiB
Markdown
52 lines
1.7 KiB
Markdown
# 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`.
|
|
- `npx` mode 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.pdf` and `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:
|
|
|
|
```bash
|
|
npx @keygraph/shannon start -u https://example.com -r /path/to/repo -w my-audit
|
|
```
|
|
|
|
Resume the same workspace:
|
|
|
|
```bash
|
|
npx @keygraph/shannon start -u https://example.com -r /path/to/repo -w my-audit
|
|
```
|
|
|
|
Resume an auto-named workspace:
|
|
|
|
```bash
|
|
npx @keygraph/shannon start -u https://example.com -r /path/to/repo -w example-com_shannon-1771007534808
|
|
```
|
|
|
|
List running and completed scans:
|
|
|
|
```bash
|
|
npx @keygraph/shannon scans
|
|
```
|
|
|
|
Source-build equivalents:
|
|
|
|
```bash
|
|
./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 scans
|
|
```
|