Co-authored-by: Kandev Agent <agent@kandev.dev>
5.1 KiB
title, description
| title | description |
|---|---|
| Kandev Documentation | Choose a guide for installing Kandev, running agent work, reviewing changes, or contributing to Kandev. |
Kandev Documentation
Kandev lets you assign repository work to coding agents, review the result, and keep control of the environment and credentials.
Start here
- Get started; install Kandev, add a repository, and run a first task.
- Tasks and workflows; create work, choose a workflow, and use plans.
- Sessions and review; supervise an agent, inspect changes, and finish safely.
- Security and trust; choose an appropriate access boundary before sharing Kandev with others.
More guides for running work
Run work in Kandev
Choose the guide that matches the job in front of you:
- Get started: install Kandev, add a local repository, configure an agent, and run a first task.
- Tasks and workflows: create tasks, use plans, configure workflow steps, and understand the Office-only document and label boundary.
- Sessions and review: work with named sessions, chat, files, terminal, changes, preview, pull requests, and walkthroughs.
- Coordinate work: use parallel sessions, targeted messages, subtasks, dependencies, multiple repositories, and additional branches.
- Agent communication: send cross-task prompts, receive replies, and negotiate contracts with built-in Kandev MCP tools.
- Agents and profiles: configure agent CLIs, models, modes, permissions, environment, passthrough, and credentials.
- Executors: choose local, worktree, Docker, SSH, or Sprites execution and understand the isolation boundary.
- Integrations: configure Azure DevOps, GitHub, GitLab, Jira, Linear, and Sentry for a workspace.
- Developer tools: use quick chat, prompts, utility agents, editors, terminal, shortcuts, and notifications.
- Automation and MCP: create scheduled or event-driven work, use task MCP, and connect an external MCP client.
- Feature status: check support boundaries, dependencies, experimental features, and unfinished work.
- Security and trust: choose a safe deployment boundary, constrain agent access, protect credentials, and preserve human review.
Installation and operation: CLI, desktop app, configuration, service, Docker, Kubernetes, and operations.
Contributor guides
Contribute to Kandev
These pages describe the current source tree and its development conventions:
- Contribution workflow: prepare a development environment and submit a focused change.
- Architecture: understand the Go backend, embedded web app, persistence, events, agent runtime, and external boundaries.
- Backend development: follow handler, service, repository, event, migration, and WebSocket conventions.
- Web development: work with the React app, state, API clients, WebSocket handlers, responsive task UI, and design system.
- Testing: choose targeted Go, Vitest, CLI, desktop, or Playwright coverage.
- Remote cloud development: bootstrap and test the Kandev source tree in an ephemeral VM or cloud workspace.
- Extension guides: add agents, executors, integrations, settings, MCP tools, prompts, and workflow behavior.
- Adding an agent CLI: implement an ACP or TUI integration end to end.
- Release process: understand versioning and the CLI, runtime, desktop, npm, Homebrew, and container release paths.
- Public docs guide: update or add a published page.
Supported product boundary
The regular Kanban workbench, task sessions, review surfaces, and task-scoped Kandev MCP are the supported product path. Some capabilities still depend on a particular agent, executor, provider, platform, credential, or install channel; those differences are called out on their topic pages.
Office is separate, disabled in the production runtime profile, feature-flagged, and still in progress. Its source, tests, specifications, and internal plans do not make persistent teams, routines, budgets, or coordinator-led autonomy a supported production contract. See Feature status for that boundary and Office provider routing for the feature-flagged routing surface.
Version matching
Match docs to the running version
These docs describe the current main branch and are not versioned. A released build can lag behind them. Check Settings > System > About or run kandev --version, then use the matching GitHub tag when exact historical behavior matters.