Open-source documentation
ShakerScan Open Source documentation, pinned to v2.12.2.
Every page here is rendered from the repository at the current stable release tag, so what you read matches what the installer runs. No account is required. When a document and the implementation disagree, the code, schema, and tests at that tag are authoritative.
Getting started
- README: install and first scanInstall, first scan, workflow selection, UI, CLI, and API orientation, safety, troubleshooting.
- First-run walkthroughConcise first-run and day-to-day operator walkthrough.
- Upgrade and rollbackBackup, upgrade verification, failure handling, and database rollback.
- Client, CLI and public checksEngine-less client install, shakerscan check, LAN and Enterprise connections, MCP, and scripted Hunt.
- Agent skills and setupHow Codex, Claude Code, OpenCode, and Pi load ShakerScan instructions and skills.
Workflows
- Product model and vocabularyCanonical names for Scan, Hunt, Findings, ASM, AI Gate, Model Intake, and devices.
- Hunt architectureHuman judgment, AI reasoning, deterministic execution and proof.
- Hunt authorization workflowSupported investigation flow, safety boundaries, and limitations.
- AI test workflowsAI Gate and Model Intake operator reference.
- Connected-device securityDevice product boundary, coverage and safety profiles, health checkpoints.
Design records, plans, and maintainer process documents are not rendered here; read them in the repository at v2.12.2. Read the v2.12.2 release notes, or every release on GitHub.