CLI Commands

Shannon exposes the same commands through two entry points. Pick your entry point. The choice is remembered across the site.

npx (recommended)

Prefix every command with npx @keygraph/shannon:

npx @keygraph/shannon <command>

Build from source

Run ./shannon from your local clone:

./shannon <command>

Commands

Command	Description
setup	Interactive wizard to configure AI provider credentials (npx mode).
start	Run a pentest against a target. See flags below.
status	Show the status of the current run.
logs <workspace>	Stream logs for a workspace.
workspaces	List all workspaces.
stop	Stop the running scan and local infrastructure.
stop --clean	Stop and clean up. Prompts for confirmation; add --yes (or -y) to skip.
uninstall	Remove Shannon’s local infrastructure (npx mode). Prompts for confirmation; add --yes (or -y) to skip.
build --no-cache	Rebuild the worker image (source-build mode).
version	Print the Shannon version (also -v, --version).
help	Show usage help.

start flags

Each flag has a short and long form.

Flag	Argument	Description
-u, --url	URL	Target application URL (required). Use host.docker.internal for local apps.
-r, --repo	path	Path to the target’s source repository (required, mounted read-only). Absolute or relative; a bare repo name also works in source-build mode.
-c, --config	path	Path to a configuration YAML file.
-o, --output	path	Copy deliverables to a custom output directory after the run.
-w, --workspace	name	Name the workspace, or resume an existing one by passing its name.
--pipeline-testing	(none)	Use minimal prompts for a fast test run.
--debug	(none)	Preserve the worker container after exit for log inspection.

Examples

npx (recommended)

# Basic pentest.
npx @keygraph/shannon start -u https://example.com -r /path/to/repo

# With a configuration file.
npx @keygraph/shannon start -u https://example.com -r /path/to/repo -c /path/to/my-config.yaml

# Custom output directory.
npx @keygraph/shannon start -u https://example.com -r /path/to/repo -o ./my-reports

# Named workspace.
npx @keygraph/shannon start -u https://example.com -r /path/to/repo -w q1-audit

# List all workspaces.
npx @keygraph/shannon workspaces

Build from source

./shannon start -u https://example.com -r /path/to/repo
./shannon start -u https://example.com -r /path/to/repo -c /path/to/my-config.yaml
./shannon start -u https://example.com -r /path/to/repo -o ./my-reports
./shannon start -u https://example.com -r /path/to/repo -w q1-audit
./shannon workspaces

# Rebuild the worker image.
./shannon build --no-cache

Monitoring

npx (recommended)

npx @keygraph/shannon logs <workspace>
npx @keygraph/shannon status

Build from source

./shannon logs <workspace>
./shannon status

Open the Temporal Web UI for detailed monitoring:

open http://localhost:8233