José Almeida
2549704bc1
* docs: expand public user and contributor guides * docs: address public guide review feedback * docs: align web e2e coverage guidance * test: cover collapsed docs references * fix: validate shortcut docs references * fix: parse balanced docs links * fix: handle indented docs code blocks
3.8 KiB
title, description
| title | description |
|---|---|
| Kandev Documentation | Choose a guide for running agentic development work or contributing to Kandev itself. |
Kandev Documentation
Kandev is an open-source workbench for planning, running, coordinating, and reviewing software work with coding agents. It runs on infrastructure you control, works with multiple agent providers, and keeps the human review surface close to the repository state.
Choose the path that matches what you are doing now.
Use Kandev
Start here when you want to install Kandev, connect repositories and tools, run agents, or design a team workflow.
- Get started: install Kandev and complete a first task.
- Tasks and workflows: choose a workflow, create tasks, and move work through gates.
- Sessions and review: use chat, files, terminal, changes, plans, pull requests, and code walkthroughs.
- Coordinate work: use subtasks, dependencies, multiple repositories, multiple branches, plans, and handoffs.
- Agents and profiles: select models and modes, configure CLI flags and environment, and understand permission controls.
- Executors: choose local, worktree, Docker, SSH, or Sprites execution.
- Integrations: connect GitHub, GitLab, Jira, Linear, Sentry, and Slack.
- Developer tools: quick chat, prompts, utility agents, voice, editors, terminal, shortcuts, and notifications.
- Automation and MCP: automate workflow transitions and let agents coordinate Kandev tasks.
- Feature status: see what is supported, optional, experimental, or still in progress.
For installation and deployment details, use the CLI reference, desktop guide, configuration reference, or one of the runtime guides under Run and Operate.
Contribute to Kandev
Start here when you are changing Kandev, extending an integration, or maintaining its public documentation.
- Contribution workflow: prepare a development environment and open a focused pull request.
- Architecture: understand the unified 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 Vite/React app, state slices, API clients, WebSocket handlers, responsive task UI, and design system.
- Testing: choose targeted Go, Vitest, CLI, desktop, or Playwright coverage and use isolated fixtures.
- Extension guides: add agents, executors, integrations, settings, MCP tools, prompts, and workflow behavior.
- Adding an agent CLI: implement a new ACP or TUI integration end to end.
- Release process: understand versioning, release automation, runtime bundles, desktop artifacts, npm, Homebrew, and containers.
- Public docs guide: update a page or add a new entry to this navigation.
Product Boundary
The regular task workbench and task-scoped Kandev MCP are shipped features. Office mode is separate and remains feature-flagged and in progress. Internal plans, ADRs, and experiments can explain direction, but they are not promises that a feature is generally available. The feature status page records that boundary explicitly.
Current Version
These docs describe the current main branch and are not versioned yet. Commands and configuration are verified against source, but a released build can lag main. Check the version in Settings > System > About or run kandev --version, then consult the corresponding GitHub tag when exact historical behavior matters.