# ShakerScan documentation

Open-source documentation is rendered from [v2.12.2](https://github.com/andriyze/shakerscan/tree/v2.12.2). Use the code, schema, and tests at that tag as the authority for released behavior.

## Agent and developer entry points

- [Client, CLI and public checks](https://shakerscan.com/markdown/docs/open-source/client.md): installation, connection setup, public checks, and MCP configuration.
- [Agent skills and setup](https://shakerscan.com/markdown/docs/open-source/skills.md): instructions for Codex, Claude Code, OpenCode, and Pi.
- [MCP adapter](https://shakerscan.com/markdown/docs/open-source/mcp.md): supported tools and permission boundaries.

The engine serves its OpenAPI schema at /openapi.json on your own instance. This website does not expose a hosted scanning API. Enterprise identity and service-token instructions apply to Enterprise deployments, not to the trusted-operator open-source engine.

## Getting started

- [README: install and first scan](https://shakerscan.com/markdown/docs/open-source/readme.md): Install, first scan, workflow selection, UI, CLI, and API orientation, safety, troubleshooting.
- [First-run walkthrough](https://shakerscan.com/markdown/docs/open-source/walkthrough.md): Concise first-run and day-to-day operator walkthrough.
- [Upgrade and rollback](https://shakerscan.com/markdown/docs/open-source/upgrade-and-rollback.md): Backup, upgrade verification, failure handling, and database rollback.
- [Client, CLI and public checks](https://shakerscan.com/markdown/docs/open-source/client.md): Engine-less client install, shakerscan check, LAN and Enterprise connections, MCP, and scripted Hunt.
- [Agent skills and setup](https://shakerscan.com/markdown/docs/open-source/skills.md): How Codex, Claude Code, OpenCode, and Pi load ShakerScan instructions and skills.

## Workflows

- [Product model and vocabulary](https://shakerscan.com/markdown/docs/open-source/product-model.md): Canonical names for Scan, Hunt, Findings, ASM, AI Gate, Model Intake, and devices.
- [Hunt architecture](https://shakerscan.com/markdown/docs/open-source/hunt-architecture.md): Human judgment, AI reasoning, deterministic execution and proof.
- [Hunt authorization workflow](https://shakerscan.com/markdown/docs/open-source/hunt-authorization-workflow.md): Supported investigation flow, safety boundaries, and limitations.
- [AI test workflows](https://shakerscan.com/markdown/docs/open-source/AI_TEST_WORKFLOWS.md): AI Gate and Model Intake operator reference.
- [Connected-device security](https://shakerscan.com/markdown/docs/open-source/connected-device-security.md): Device product boundary, coverage and safety profiles, health checkpoints.

## Architecture and operations

- [DAST execution and Continuous ASM](https://shakerscan.com/markdown/docs/open-source/dast-asm-architecture.md): Local and broker execution model and safety boundaries.
- [Multi-node Fleet guide](https://shakerscan.com/markdown/docs/open-source/multi-node-guide.md): Fleet setup, enrollment, drain, resume, and revoke.
- [MCP adapter](https://shakerscan.com/markdown/docs/open-source/mcp.md): Read-only Arsenal and target-bound Hunt trust levels over MCP.

## Enterprise

- [Enterprise guides](https://shakerscan.com/docs/enterprise): self-hosted deployment, single sign-on, agent connections, recurring scans, retests, Jira, and security overview.