Open-source documentation
Documentation for the open-source platform, pinned to v2.12.2.
Rendered from the repository at the current stable release tag, so what you read matches what the installer runs. No account is required.
Browse all open-source documentationGetting 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.
Source: docs/README.md in andriyze/shakerscan. A running installation also serves its own README under Docs and its OpenAPI document at /openapi.json.
Three ways to connect
- Public check
- No install or account. Our hosted service returns DNS, email, HTTP and TLS facts for a public domain.
- shakerscan check example.com
- Client guide
- Your own engine
- Scan and Hunt run on your machine. The API has no login, so keep it local or behind your VPN; its schema is at /openapi.json.
- curl -fsSL https://install.shakerscan.com | sh
- Agent setup
- Enterprise
- Your instance, behind single sign-on. The console issues a service token and a one-time connect link for agents and scripts.
- shakerscan connect <connect link>
- Connect an agent
Enterprise documentation
Self-hosted ShakerScan Enterprise, on your infrastructure.
Installing on a Linux host in one command, OIDC single sign-on with Okta, service tokens and connecting Claude Code, Codex or OpenCode to your instance, Hunt, and the security overview a procurement review asks for.
Browse the Enterprise guidesLegal and trust