Kiro Crew user documentation

September 6, 2026 · View on GitHub

These docs ship inside the Python package. They are the end-user documentation: in-app reading, dashboard Settings links, and the feature-tips catalog all resolve here. Contributor and architecture docs live in ../../../docs/.

index.md is the in-app entry point. This README is the same set, organized for someone browsing the repository.

Getting started

DocCovers
getting-started.mdInstall, first run, and background operation.
configuration.mdConfig file reference, environment variables, and sandbox modes.
use-cases.mdReal-world workflows.
troubleshooting.mdCommon problems and fixes.
blocked-commands.mdWhy a command was refused, what the agent is told to do instead, and how to check your credential setup.

Core capabilities

DocCovers
agents.mdSwitching between specialized agents per conversation, thread, or cron job.
skills.mdDrop-in markdown knowledge packs for domain-specific workflows.
cron-and-scheduling.mdScheduling recurring tasks.
subagents.mdSpawning parallel background workers for fan-out work.
dynamic-subagent-sizing.mdHow the concurrent sub-agent cap is sized from host memory and CPU.
task-runner.mdAutonomous multi-step execution from a spec file.
research-lab.mdMulti-cycle research campaigns with exportable reports.
memory-and-learning.mdPersistent preferences, project context, and learned corrections.
knowledge-library-how-it-works.mdHow the knowledge graph is built from your documents.
dashboard.mdThe web dashboard: multi-session chat, memory management, live metrics.
agent-questions.mdLetting an agent pause mid-turn to ask a clickable question.
followup-suggestions.mdAgent-proposed next steps above the composer.
feature-tips.mdPersonalized tips pointing at features you have not used.
inbound-webhooks.mdLetting external systems trigger an agent turn over HTTP.
deploy-web.mdPublishing artifacts to a public HTTPS URL on your own AWS.
snapshot-and-restore.mdBacking up and restoring Kiro Crew state.
workflows.mdMulti-phase agent runs you can watch, restart in part, and save for reuse.
secrets-vault.mdStoring credentials encrypted where the agent cannot read them.
monitor-loops.mdKeeping one session checking something on an interval until an exit condition fires.
session-ledger.mdThe durable per-session work record that survives context compaction.
artifacts.mdSaving, versioning, and reverting generated UI and documents.
computer-use.mdReading and driving native desktop applications; opt-in and off by default.
browser-control.mdDriving a real web page from the dashboard's Browser panel.

Channels

DocCovers
slack-integration.mdSlack DMs, tool approval, streaming, channel monitoring.
discord-integration.mdDiscord setup and behavior.
telegram-integration.mdTelegram setup and behavior.
teams-integration.mdMicrosoft Teams setup, including Azure Bot registration.
webex-integration.mdWebex setup and behavior.
wecom-integration.mdWeCom setup and behavior.
weixin-integration.mdWeixin setup, and the risks to read first.
whatsapp-integration.mdWhatsApp (QR-linked personal account) setup, and the risks to read first.
feishu-integration.mdFeishu (Lark/飞书) setup and behavior.
imessage-integration.mdiMessage setup and behavior on a Mac that owns the Messages database.
channel-capabilities.mdOne matrix of what every channel can do: streaming, buttons, uploads, reply length, approval timeout.

Platform

DocCovers
mcp-apps.mdRendering interactive MCP tool output in chat: the two gates, what a server declares, and the plain-text fallback.

Maintaining this directory

Two constraints make this tree different from docs/:

  • Filenames are an API. tips.py globs *.md here and filters through tips_allowlist.py, extracting each doc's H1 and first paragraph into the in-app feature catalog; dashboard Settings panels hardcode GitHub URLs to specific filenames; and a test pins one name. Renaming or deleting a file here is a code change, and a doc dropped from the catalog fails silently. scripts/docs-lint.sh pins the coupled names.
  • The tree is flat, deliberately. setup.cfg's package_data glob for this directory does not recurse, so a file in a subdirectory would ship in the sdist but be missing from the wheel.

Because every doc here reaches every user, keep the content task-oriented and free of internal design narration. An engineering note belongs in ../../../docs/ instead. Each doc's first paragraph is read verbatim as a feature description, so write it to stand alone.