Guides
These guides explain how to install and run komrad, on your own machine or on a remote instance.
Getting started
- 01Installing komradGet up and running with the komrad binary.
- 02WorkflowsThe templates tasks and agents are created from, and what each one decides for them.
- 03TasksThe outcome agents work toward, and the worktree, branch, pull request, reviews and notes that come with it.
- 04AgentsThe three kinds of agent, how they work together on tasks, and how komrad knows what each one is doing.
- 05ReviewsReview a task's change locally, push it, open and merge its pull request, and clean up after.
- 06Navigating komradKomrad's navigation is keyboard based, and inspired by vim.
- 07HooksYour own scripts, run by komrad at moments in an agent's or a task's life.
- 08SchedulesLaunch agents or mail an orchestrator on a timer, and what happens when a run is late or busy.
- 09DocumentsHave an agent write an RFC, a report or notes, refine it with it, and step through every version.
- 10Events and messagesHow agents message each other, and how komrad tells them when something they care about changes.
- 11MCPHow agents see and manage other agents through komrad's MCP server.
- 12SDKsCreate and manage agents from your own programs.
- 13Remote enginesKeep the panel on your laptop and run the agents on a machine that never sleeps.
- 14BugsWhat to check first, what to include, and how to write steps someone else can follow to see the bug.
- 15Sending logs to a collectorHow to send komrad's log lines, and the records its agents' CLIs export, to an OpenTelemetry collector or a backend that takes OTLP.
- 16Memory and storage limitsHow komrad stays inside the memory and disk space you give it, which agents it makes dormant first, and which worktrees it deletes first.
Remote engines
- 17Running komrad remotelyHow remote engines extend komrad on a laptop to a team, with an engine for each person and a control plane in front.
- 18Komrad's engineThe AWS engines komrad's own team works on, from the control plane and each person's engine to the database, sign-in, the network and credentials.
- 19Standing up an engineReplicate komrad's AWS engines in your own account, then run them day to day.
Architecture
- 20How it worksThe server, the panel, tmux, and the one API everything goes through.
- 21PhilosophyAn overview of the design principles behind komrad.
- 22Data flowHow komrad efficiently renders the UI and reacts to writes in Postgres
- 23The shape of the codeThe layers, what may import what, the linters that hold the line, and where tests live.