Start with the README. CONTRIBUTING.md covers building, testing and releasing.
| File | Covers |
|---|---|
| running.md | The launcher, docker run and podman run, sudo, file ownership, upgrading |
| logins.md | Signing in to each agent, which Claude login wins, GitHub tokens |
| agents.md | Where each agent keeps settings, instructions and skills, status lines, MCP logins |
| defaults.md | Seeded shell, tool and agent configuration, colors and customization paths |
| customization.md | Your own configs, bind-mounted homes, separate test homes and custom images |
| configuration.md | The shared AGENTS.md, MCP servers, tools that agents install, OpenRouter |
| project-tools.md | Python and JavaScript tooling, native builds, PostgreSQL scripts and lockfiles |
| browser-testing.md | Optional Playwright setup, persistent browsers and execution checks |
| language-tooling.md | Optional Go, Rust, Python and TypeScript language servers |
| plugins.md | Optional plugins, RTK output filtering, context-mode indexing, Context7 and local Neuledge documentation lookup |
| extras.md | Optional Kandev, OpenChamber and REA installs with agentainer-extras |
| monitoring.md | Manual abtop session monitoring, snapshot output and model-call behavior |
| kubernetes.md | The Kubernetes example with ContainerSSH |
| kelos.md | The Kelos variant image: what it adds, building and testing it |
| security.md | What the container isolates, agent permissions, vulnerability reports |
| versions.md | Pinned versions, the scheduled update, releases |
| troubleshooting.md | Offline diagnostics, error messages and their fixes |