CalvinBackup/shannon
1
0
Fork 0
mirror of https://github.com/KeygraphHQ/shannon.git synced 2026-09-28 12:31:56 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore(license): attribute Mantis and Pi and refresh the docs

Browse Source 
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.
This commit is contained in:
ajmallesh
2026-08-26 20:19:41 -07:00
parent 85d5cbd657
commit 2469e6deac
97 changed files with 385 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/development.md
+7 -5
View File
@@ -57,12 +57,14 @@ The target repository is mounted read-only inside the worker container.
Monitor progress:
```bash
npx @keygraph/shannon logs <workspace>
npx @keygraph/shannon status <workspace>
npx @keygraph/shannon logs [<workspace>] # defaults to the single running scan, else the most recent
npx @keygraph/shannon status [<workspace>] # same default target; add --json for a machine-readable snapshot
npx @keygraph/shannon scans
npx @keygraph/shannon version
```
With no workspace, `logs` and `status` follow the single running scan; when several are running, name one.
Source-build equivalents:
```bash
@@ -89,7 +91,7 @@ open http://localhost:8233
Stop Shannon:
```bash
npx @keygraph/shannon stop <workspace> # stop one scan (confirms first; add --yes/-y to skip)
npx @keygraph/shannon stop [<workspace>] # stop one scan (defaults to the single running scan; confirms first; add --yes/-y to skip)
npx @keygraph/shannon stop --all # stop all scans (Temporal stays up)
npx @keygraph/shannon reset # stop everything and wipe all Temporal data (type 'confirm' to proceed; cannot be skipped)
```
@@ -97,7 +99,7 @@ npx @keygraph/shannon reset # stop everything and wipe all Temporal
Source-build equivalents:
```bash
./shannon stop <workspace> # stop one scan (confirms first; add --yes/-y to skip)
./shannon stop [<workspace>] # stop one scan (defaults to the single running scan; confirms first; add --yes/-y to skip)
./shannon stop --all # stop all scans (Temporal stays up)
./shannon reset # stop everything and wipe all Temporal data (type 'confirm' to proceed; cannot be skipped)
```
@@ -120,7 +122,7 @@ npx @keygraph/shannon start -u https://example.com -r /path/to/repo -w q1-audit
# Stream the log until the scan finishes, then exit on its outcome (useful in CI).
npx @keygraph/shannon start -u https://example.com -r /path/to/repo --follow
# List completed scans.
# List running and completed scans.
npx @keygraph/shannon scans
```