dreampiler/kandev
1
0
Fork 0
Code Issues 43 Pull Requests Actions 6 Packages Projects Releases Wiki Activity

docs: update and review main documentation (#259)

Browse Source
This commit is contained in:
Nuno Nobre
2026-02-22 10:17:51 +00:00
committed by GitHub
parent 008d9819f9
commit d82aec1c0e
2 changed files with 15 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -5
View File
@@ -1,6 +1,6 @@
# Kandev # Kandev
Manage tasks. Orchestrate agents. Review changes. Ship value. Manage and run tasks in parallel. Orchestrate agents. Review changes. Ship value.
[Workflows](docs/workflow-tips.md) | [Roadmap](docs/roadmap.md) | [Contributing](CONTRIBUTING.md) | [Architecture](docs/ARCHITECTURE.md) [Workflows](docs/workflow-tips.md) | [Roadmap](docs/roadmap.md) | [Contributing](CONTRIBUTING.md) | [Architecture](docs/ARCHITECTURE.md)
@@ -9,7 +9,7 @@ Manage tasks. Orchestrate agents. Review changes. Ship value.
## What ## What
Organize work across kanban and pipeline views with opinionated workflows. Assign agents from any provider, and review their output in an integrated workspace - file editor, file tree, terminal, browser preview, and git changes in one place. Terminal agent TUIs are great for running agents, but reviewing and iterating on changes there doesn't scale. Organize work across kanban and pipeline views with opinionated workflows and execute multiple tasks in parallel. Assign agents from any provider, and review their output in an integrated workspace - file editor, file tree, terminal, browser preview, and git changes in one place. Terminal agent TUIs are great for running agents, but reviewing and iterating on changes there doesn't scale.
Run it locally or self-host it on your own infrastructure and access it from anywhere via [Tailscale](https://tailscale.com/) or any VPN. Run it locally or self-host it on your own infrastructure and access it from anywhere via [Tailscale](https://tailscale.com/) or any VPN.
@@ -33,6 +33,7 @@ While agents can already plan, implement, test, and deploy autonomously with the
## Features ## Features
- **Multi-agent support** - Claude Code, Codex, GitHub Copilot, Gemini CLI, Amp, Auggie, OpenCode - **Multi-agent support** - Claude Code, Codex, GitHub Copilot, Gemini CLI, Amp, Auggie, OpenCode
- **Parallel task execution** – start and manage multiple tasks from different sources simultaneously, boosting efficiency and productivity with AI agents.
- **Integrated workspace** - Built-in terminal, code editor with LSP, git changes panel, and chat in one IDE-like view - **Integrated workspace** - Built-in terminal, code editor with LSP, git changes panel, and chat in one IDE-like view
- **Kanban task management** - Drag-and-drop boards, columns, and workflow automation - **Kanban task management** - Drag-and-drop boards, columns, and workflow automation
- **Agentic workflows** - Multi-step pipelines that chain agents through automated task routing. See [docs/workflows.md](docs/workflow-tips.md) - **Agentic workflows** - Multi-step pipelines that chain agents through automated task routing. See [docs/workflows.md](docs/workflow-tips.md)
@@ -45,7 +46,7 @@ While agents can already plan, implement, test, and deploy autonomously with the
## Supported Agents ## Supported Agents
| Agent | Default Model | Other Models | Protocol | | Agent | Default Model | Other Models | Protocol |
|-------|--------------|--------------|----------| |:-------:|:--------------:|--------------|:----------:|
| **Claude Code** | Sonnet 4.5 | Opus 4.6, Opus 4.5, Haiku 4.5 | stream-json | | **Claude Code** | Sonnet 4.5 | Opus 4.6, Opus 4.5, Haiku 4.5 | stream-json |
| **Codex** | GPT-5.2 Codex | GPT-5.1 Codex Max, GPT-5.1 Codex Mini, GPT-5.2 | Codex | | **Codex** | GPT-5.2 Codex | GPT-5.1 Codex Max, GPT-5.1 Codex Mini, GPT-5.2 | Codex |
| **GitHub Copilot** | GPT-4.1 | GPT-5.2, Claude Sonnet 4.5, Gemini 3 Pro, +10 more | Copilot SDK | | **GitHub Copilot** | GPT-4.1 | GPT-5.2, Claude Sonnet 4.5, Gemini 3 Pro, +10 more | Copilot SDK |
@@ -66,7 +67,7 @@ While agents can already plan, implement, test, and deploy autonomously with the
npx kandev npx kandev
``` ```
This downloads prebuilt backend + frontend bundles and starts them locally. The worktrees and sqlite db will be created in `~/.kandev` by default. Should work on macOS, Linux, and Windows (WSL or native). This downloads pre-built backend + frontend bundles and starts them locally. The worktrees and sqlite db will be created in `~/.kandev` by default. Should work on macOS, Linux, and Windows (WSL or native).
### From Source ### From Source
@@ -160,7 +161,7 @@ pre-commit install
## Comparison to Other Tools ## Comparison to Other Tools
There are a couple similar tools in this space, and new ones appearing everyday. Here's what sets this one apart: There are a few similar tools in this space, and new ones appearing everyday. Here's what sets this one apart:
- **Server-first architecture** - Not a desktop app. Runs as a server you can access from any device, including your phone. Start a task away from your computer and check in on it later. - **Server-first architecture** - Not a desktop app. Runs as a server you can access from any device, including your phone. Start a task away from your computer and check in on it later.
- **Remote runtimes** - Run agents on remote servers and Docker hosts, not just your local machine. - **Remote runtimes** - Run agents on remote servers and Docker hosts, not just your local machine.
docs/workflow-tips.md
+9 -9
View File
@@ -2,7 +2,7 @@
Kandev ships with four workflow templates. Each defines a sequence of steps with automated transitions - agents start, stop, and move between steps based on events like entering a step, sending a message, or an agent completing its turn. Kandev ships with four workflow templates. Each defines a sequence of steps with automated transitions - agents start, stop, and move between steps based on events like entering a step, sending a message, or an agent completing its turn.
You can use these as-is or **create custom workflows** tailored to your or your team. You can use these as-is or **create custom workflows** tailored to you or your team.
## Default Workflows ## Default Workflows
@@ -13,9 +13,9 @@ Classic kanban board with automated agent execution. Good for straightforward ta
**Steps:** Backlog → In Progress → Review → Done **Steps:** Backlog → In Progress → Review → Done
| Step | What happens | | Step | What happens |
|------|-------------| |:------:|-------------|
| **Backlog** | Tasks wait here. Sending a message moves the task to In Progress. | | **Backlog** | Backlog of tasks not yet started. Sending a message moves the task to In Progress. |
| **In Progress** | Agent starts automatically. When it completes, the task moves to Review. | | **In Progress** | Agent starts the work automatically. When it completes, the task moves to Review. |
| **Review** | You review the agent's work. Sending a message moves it back to In Progress for another iteration. | | **Review** | You review the agent's work. Sending a message moves it back to In Progress for another iteration. |
| **Done** | Final state. Sending a message reopens the task in In Progress. | | **Done** | Final state. Sending a message reopens the task in In Progress. |
@@ -34,8 +34,8 @@ Two-phase workflow where the agent first creates a plan for your review, then im
**Steps:** Todo → Plan → Implementation → Done **Steps:** Todo → Plan → Implementation → Done
| Step | What happens | | Step | What happens |
|------|-------------| |:------:|-------------|
| **Todo** | Backlog. Move tasks here when they're ready to be planned. | | **Todo** | Tasks ready to be planned. |
| **Plan** | Agent analyzes the task and creates a detailed implementation plan - requirements, files to modify, step-by-step approach, risks. Supports mermaid diagrams. The plan is saved via MCP tool and the agent stops for your review. You can edit the plan in the UI before moving forward. | | **Plan** | Agent analyzes the task and creates a detailed implementation plan - requirements, files to modify, step-by-step approach, risks. Supports mermaid diagrams. The plan is saved via MCP tool and the agent stops for your review. You can edit the plan in the UI before moving forward. |
| **Implementation** | Agent retrieves the plan (including your edits), acknowledges modifications, and implements step-by-step. Moves to Done on completion. | | **Implementation** | Agent retrieves the plan (including your edits), acknowledges modifications, and implements step-by-step. Moves to Done on completion. |
| **Done** | Final state. | | **Done** | Final state. |
@@ -50,12 +50,12 @@ Two-phase workflow where the agent first creates a plan for your review, then im
### Architecture ### Architecture
Focused on design and architecture. The agent creates technical designs for your review - no implementation happens in this workflow. Useful for capturing architectural decisions before any code is written. Focused on design and architecture. The agent creates technical designs for you to review - no implementation happens in this workflow. Useful for capturing architectural decisions before any code is written.
**Steps:** Ideas → Planning → Review → Approved **Steps:** Ideas → Planning → Review → Approved
| Step | What happens | | Step | What happens |
|------|-------------| |:------:|-------------|
| **Ideas** | Backlog of architectural ideas and proposals. | | **Ideas** | Backlog of architectural ideas and proposals. |
| **Planning** | Agent analyzes the task, asks clarifying questions, and produces an architectural design with mermaid diagrams. Saves the design and stops for your review. | | **Planning** | Agent analyzes the task, asks clarifying questions, and produces an architectural design with mermaid diagrams. Saves the design and stops for your review. |
| **Review** | You review the design. Sending a message moves it back to Planning for revisions. | | **Review** | You review the design. Sending a message moves it back to Planning for revisions. |
@@ -76,7 +76,7 @@ Track pull requests through automated code review. The agent reviews changed fil
**Steps:** Waiting → Review → Done **Steps:** Waiting → Review → Done
| Step | What happens | | Step | What happens |
|------|-------------| |:------:|-------------|
| **Waiting** | PR queue. Sending a message starts the review process. | | **Waiting** | PR queue. Sending a message starts the review process. |
| **Review** | Agent reviews the changed files in the git worktree. If there are uncommitted changes, it reviews those; otherwise, it reviews commits that diverged from the main branch. Findings are organized into four categories: **BUG**, **IMPROVEMENT**, **NITPICK**, **PERFORMANCE** - each with file:line references. | | **Review** | Agent reviews the changed files in the git worktree. If there are uncommitted changes, it reviews those; otherwise, it reviews commits that diverged from the main branch. Findings are organized into four categories: **BUG**, **IMPROVEMENT**, **NITPICK**, **PERFORMANCE** - each with file:line references. |
| **Done** | Review complete. Sending a message moves it back to Review for another pass. | | **Done** | Review complete. Sending a message moves it back to Review for another pass. |