Guides
September 4, 2026 · View on GitHub
Task-oriented documentation: how to install, run, and operate Kiro Crew. For how the system is built, see ../architecture/.
| Guide | Covers |
|---|---|
| install.md | Installing and building Kiro Crew: source, wheel, and first run. |
| worktree-verification-recipes.md | Copy-pasteable backend, frontend, agent-driving, diagnosis, and reclamation traces against an isolated worktree pod. |
| windows-install.md | Native Windows setup, and the per-feature status on Windows. |
| macos-troubleshooting.md | macOS desktop app issues — a CLI that resolves in Terminal but is command not found inside the app, and the launchctl setenv PATH recipe that fixes it. |
| docker.md | Running Kiro Crew as a container. |
| docker-troubleshooting.md | Diagnosing common Docker deployment issues. |
| remote-and-mobile.md | Running 24/7 on a remote host, keeping it alive as a service, and reaching it from a phone over a tunnel. |
| cloud-instance-ssm-vs-ssh.md | How a cloud-launched instance is reached through the Instances hub: the native AWS SSM transport vs the legacy SSH-over-ProxyCommand path. |
| remote-crew-on-ec2.md | Reaching a Remote Instance gateway on EC2 over SSH or AWS SSM, plus the common EC2 setup gotchas (sandbox backend, linger, port/tunnel matching). |
| slack-setup.md | Creating and configuring the Slack app. |
| enterprise-mcp-governance.md | Running Kiro Crew on an enterprise Kiro account (IAM Identity Center / API key) whose administrator allow-lists MCP servers through a registry: why features go silently missing, and the two-sided fix. Also the admin-facing rollout for central policy distribution — publishing one security_policy.json that every host fetches, caches and re-fetches. |
| connecting-remote-oauth-mcp-server.md | Adding and authenticating a remote HTTP/OAuth MCP server (worked example: Miro) end to end: the right config for your agent, the includeMcpJson: false gotcha, the inline Authorize banner that carries the consent URL, the browser flow (including the paste-back relay a remote gateway needs), the oauth_endpoints.json allowlist for unrecognized hosts, and why registering the new tools takes a drained warm pool, not just a new chat. |
| secrets-env.md | Passing secrets (API keys, tokens) to MCP servers via systemd environment directives or a shell wrapper — interim workarounds pending the encrypted vault. |
| telemetry-otlp-export.md | Pushing Kiro Crew's OpenTelemetry metrics to a collector and on to CloudWatch, Datadog, or any OTLP-compatible backend: the two separate consent switches, collector config samples, the temporality setting that decides whether a backend accepts the data, what is and is not exported, and how to verify the path end to end. |
| — | Other chat channels (Discord, Telegram, Teams, Webex, WeCom, WeChat) are documented in ../../src/kiro_crew/docs/; the channel-neutral transport contract is messaging.md. |
assets/ holds the copy-pasteable service unit, launchd plist, and setup script
that remote-and-mobile.md refers to, plus an example
security_policy.json that
governance.md and
enterprise-mcp-governance.md refer to.
End-user feature documentation is not here: it ships in the package under
../../src/kiro_crew/docs/.