-
-
Notifications
You must be signed in to change notification settings - Fork 205
Documentation Map
Use this map when the Wiki explains the task but you need an exact, versioned contract.
| Need | Best source |
|---|---|
| Decide what to do and in what order | This Wiki |
| Product overview and installation | README |
| System components and data flow | ARCHITECTURE.md |
| REST/WebSocket schemas | docs/API.md |
| CLI flags and commands | docs/CLI.md |
| Hook events, wrappers, and remote delivery | docs/HOOKS.md |
| MCP transports, tools, and policy gates | docs/MCP.md |
| Production topology and recovery commands | docs/DEPLOYMENT.md |
| Tables, indexes, migrations, persistence | docs/DATABASE.md |
| Plugins and packaged skills | docs/PLUGINS.md |
| Localization workflow | docs/I18N.md |
| Security reporting and supported versions | Security policy |
Wiki guidance follows the current master branch. If your installation is older, switch repository links from master to the deployed vX.Y.Z tag before copying commands or environment variables.
CCAM also ships an in-app/static localized Wiki for the product and architecture tour. It complements this operator handbook; it is not a duplicate of the GitHub Wiki or the technical reference.
Start Here · Localized product Wiki · Repository · Releases · Security · Report an issue
Guidance tracks the current master branch. For a deployed release, consult the repository documentation at that release tag before changing configuration.
CCAM Handbook
Use CCAM
- Read the dashboard
- Sessions and agents
- Kanban and tasks
- Tokens and costs
- Run agents
- Personal settings
Operate CCAM
- Deployment guide
- Hook health
- Security
- Backups and retention
- Prometheus and Grafana
- Remote machines
- Upgrades and rollback
- Incident runbooks
Automate and extend
- CLI patterns
- MCP workflows
- Alerts and webhooks
- Dynamic workflows
- Skills and plugins
- Safe config explorer
- Integration patterns
Help