mirror of
https://github.com/KeygraphHQ/shannon.git
synced 2026-07-05 12:47:57 +02:00
feat(cli): restructure run folder and improve terminal UX (#384)
* 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
This commit is contained in:
@@ -98,7 +98,7 @@ Shannon supports pointing the SDK at an Anthropic-compatible endpoint with `ANTH
|
||||
> [!IMPORTANT]
|
||||
> Only Claude models are officially supported. Shannon's evaluations, internal testing, and agent harness are optimized for Claude. Smaller or alternative models, including non-Claude models routed through a proxy, may not reliably follow Shannon's instructions or tool-use constraints. Use them at your own risk.
|
||||
|
||||
The experimental `claude-code-router` integration is being removed. If you rely on it, migrate to an Anthropic-compatible proxy such as LiteLLM before upgrading.
|
||||
The experimental `claude-code-router` integration has been removed. If you previously relied on it, migrate to an Anthropic-compatible proxy such as LiteLLM.
|
||||
|
||||
Run `npx @keygraph/shannon setup` and select **Custom Base URL**, or export variables directly:
|
||||
|
||||
|
||||
+14
-10
@@ -61,6 +61,7 @@ Monitor progress:
|
||||
```bash
|
||||
npx @keygraph/shannon logs <workspace>
|
||||
npx @keygraph/shannon status
|
||||
npx @keygraph/shannon version
|
||||
```
|
||||
|
||||
Source-build equivalents:
|
||||
@@ -68,6 +69,7 @@ Source-build equivalents:
|
||||
```bash
|
||||
./shannon logs <workspace>
|
||||
./shannon status
|
||||
./shannon version
|
||||
```
|
||||
|
||||
Open the Temporal Web UI for detailed monitoring:
|
||||
@@ -80,15 +82,15 @@ Stop Shannon:
|
||||
|
||||
```bash
|
||||
npx @keygraph/shannon stop
|
||||
npx @keygraph/shannon stop --clean
|
||||
npx @keygraph/shannon uninstall
|
||||
npx @keygraph/shannon stop --clean # confirms first; add --yes (or -y) to skip
|
||||
npx @keygraph/shannon uninstall # confirms first; add --yes (or -y) to skip
|
||||
```
|
||||
|
||||
Source-build equivalents:
|
||||
|
||||
```bash
|
||||
./shannon stop
|
||||
./shannon stop --clean
|
||||
./shannon stop --clean # add --yes (or -y) to skip the confirmation
|
||||
```
|
||||
|
||||
Usage examples:
|
||||
@@ -132,14 +134,16 @@ Results are saved to the workspaces directory:
|
||||
|
||||
Use `-o <path>` to copy deliverables to a custom output directory after a run completes.
|
||||
|
||||
Output structure:
|
||||
Output structure — the run directory's top level holds only the final report; everything else is nested under a hidden `.shannon/` directory:
|
||||
|
||||
```text
|
||||
workspaces/{hostname}_{sessionId}/
|
||||
|-- session.json
|
||||
|-- workflow.log
|
||||
|-- agents/
|
||||
|-- prompts/
|
||||
`-- deliverables/
|
||||
`-- comprehensive_security_assessment_report.md
|
||||
|-- Security-Assessment-Report.md # the final report (the deliverable)
|
||||
`-- .shannon/ # internals
|
||||
|-- deliverables/ # report source, per-phase analysis, queues
|
||||
|-- agents/ # per-agent logs
|
||||
|-- prompts/ # rendered prompts
|
||||
|-- scratchpad/ # screenshots, scripts
|
||||
|-- session.json # resume state
|
||||
`-- workflow.log
|
||||
```
|
||||
|
||||
@@ -11,6 +11,7 @@ Shannon uses workspaces to store scan state, logs, prompts, and deliverables. Wo
|
||||
- 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.
|
||||
|
||||
Reference in New Issue
Block a user