# Shannon

> Shannon is Keygraph's open-source AI pentester (AGPL-3.0) for web applications and APIs. It reads your source code, runs real exploits against the running app, and reports only the findings it can prove. Keygraph's commercial editions, Keygraph Pro and Keygraph Enterprise, are powered by an enhanced, enterprise-grade version of the Shannon engine.

- Run Shannon with `npx @keygraph/shannon` (Docker and Node.js 18+), or build it from source (Docker, pnpm, and Node.js 20.19+).
- `npx @keygraph/shannon start -u <url> -r <repo>` starts a scan; `npx @keygraph/shannon scans` lists running and completed scans.
- One setting, `SHANNON_AI_MODEL=<provider>:<model-id>`, picks the provider and model for the whole scan. You always bring your own key.
- Run Shannon only against applications you own or are authorized to test, and never against production.

## Documentation Sets

- [Abridged documentation](https://keygraph.io/docs/llms-small.txt): a compact version of the documentation for Shannon, with non-essential content removed
- [Complete documentation](https://keygraph.io/docs/llms-full.txt): the full documentation for Shannon

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation

## Optional

- [Shannon on GitHub](https://github.com/KeygraphHQ/shannon): Source, README, releases, and the public benchmark.
- [Keygraph site overview](https://keygraph.io/llms.txt): The Keygraph platform, pricing, and comparisons.