shannon
Shannon is an AI pentester for web applications and APIs. It analyzes your source code, identifies attack vectors, and executes real exploits to prove vulnerabilities before they reach production.
File Explorer
Download Latest Version (.zip)- debug.md
- pr.md
- review.md
- bug_report.yml
- feature_request.yml
- release-beta.yml
- release.yml
- rollback-beta.yml
- rollback.yml
- compose.yml
- build.ts
- logs.ts
- reset.ts
- scans.ts
- setup.ts
- start.ts
- status.ts
- stop.ts
- resolver.ts
- writer.ts
- derive.ts
- pipeline.ts
- render.ts
- status-json.ts
- args.ts
- colors.ts
- confirm.ts
- docker.ts
- env.ts
- errors.ts
- help.ts
- home.ts
- index.ts
- mode.ts
- model-spec.ts
- paths.ts
- session.ts
- splash.ts
- suggest.ts
- temporal-client.ts
- tty.ts
- ui.ts
- version.ts
- .npmignore
- package.json
- README.md
- tsconfig.json
- tsdown.config.ts
- config-schema.json
- example-config.yaml
- _filesystem.txt
- exploit-auth.txt
- exploit-authz.txt
- exploit-injection.txt
- exploit-ssrf.txt
- exploit-xss.txt
- pre-recon-code.txt
- recon.txt
- report-executive.txt
- validate-authentication.txt
- vuln-auth.txt
- vuln-authz.txt
- vuln-injection.txt
- vuln-ssrf.txt
- vuln-xss.txt
- _code-path-rules.txt
- _exploit-scope.txt
- _rules-of-engagement.txt
- _rules.txt
- _shared-session.txt
- _target.txt
- _vuln-scope.txt
- login-instructions.txt
- exploit-auth.txt
- exploit-authz.txt
- exploit-injection.txt
- exploit-ssrf.txt
- exploit-xss.txt
- pre-recon-code.txt
- recon.txt
- report-executive.txt
- validate-authentication.txt
- vuln-auth.txt
- vuln-authz.txt
- vuln-injection.txt
- vuln-ssrf.txt
- vuln-xss.txt
- index.ts
- permission-system.ts
- pi-executor.ts
- retry-settings.ts
- session-tools.ts
- task-tool.ts
- turn-error.ts
- audit-logger.ts
- models.ts
- output-formatters.ts
- playwright-config-writer.ts
- progress-manager.ts
- queue-schemas.ts
- submit-tool.ts
- types.ts
- audit-session.ts
- index.ts
- log-stream.ts
- logger.ts
- metrics-tracker.ts
- utils.ts
- workflow-logger.ts
- exploit-collector.ts
- finding-collector.ts
- pre-recon-collector.ts
- recon-collector.ts
- schema.ts
- vuln-collector.ts
- checkpoint-provider.ts
- findings-provider.ts
- index.ts
- report-output-provider.ts
- generate-totp.ts
- save-deliverable.ts
- set-report-meta.ts
- agent-execution.ts
- agent-git-paths.ts
- code-location-join.ts
- config-loader.ts
- container.ts
- error-handling.ts
- exploit-renderer.ts
- exploitation-checker.ts
- findings-renderer.ts
- git-manager.ts
- index.ts
- pdf-renderer.ts
- pre-recon-renderer.ts
- preflight.ts
- prompt-manager.ts
- queue-validation.ts
- recon-renderer.ts
- report-json-adapter.ts
- report-output-schema.ts
- report-renderer.ts
- reporting.ts
- sarif-renderer.ts
- validate-authentication.ts
- vuln-renderer.ts
- activities.ts
- activity-logger.ts
- pipeline.ts
- shared.ts
- summary-mapper.ts
- worker.ts
- workflow-errors.ts
- workflows.ts
- activity-logger.ts
- agents.ts
- audit.ts
- config.ts
- deliverables.ts
- errors.ts
- index.ts
- metrics.ts
- result.ts
- browser-agents.ts
- concurrency.ts
- file-io.ts
- formatting.ts
- functional.ts
- glob.ts
- metrics.ts
- config-parser.ts
- paths.ts
- progress-indicator.ts
- session-manager.ts
- keygraph-logo.png
- report.typ
- package.json
- tsconfig.json
- announcements.png
- Demo_Button.png
- discord_button_dark.png
- discord_button_light.png
- github-banner-dark.png
- github-banner-light.png
- keygraph_button_dark.png
- keygraph_button_light.png
- linkedin.png
- shannon-action.gif
- shannon-banner.png
- shannon-screen.png
- ai-providers.md
- configuration.md
- coverage-roadmap.md
- development.md
- keygraph-platform.md
- platforms.md
- safety.md
- workspaces.md
- .gitkeep
- shannon-report-capital-api.md
- shannon-report-crapi.md
- shannon-report-juice-shop.md
- .gitkeep
- .dockerignore
- .env.example
- .gitattributes
- .gitignore
- .npmrc
- .releaserc.json
- biome.json
- CLAUDE.md
- COVERAGE.md
- docker-compose.yml
- Dockerfile
- entrypoint.sh
- LICENSE
- llms-full.txt
- llms.txt
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- README.md
- shannon
- tsconfig.base.json
- tsconfig.json
- turbo.json
# Installation Guide
1. Get the code
git clone https://github.com/KeygraphHQ/shannon
Downloads the entire project code from GitHub to your computer.
cd shannon
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f apps/cli/infra/compose.yml up -d --build
Runs the command against the services defined in the compose file.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Node.js
EasyPrerequisites
cd apps/cli
This project's files live in a subfolder, so move into it first.
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation
Was this content helpful?
(0 ratings)