From 6a7bf92893ec8b3699ce65a1d4e2e968c039ce33 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Flor=C3=AAncio?= Date: Thu, 18 Jun 2026 12:00:57 +0100 Subject: [PATCH] docs: refresh feature documentation (#1424) --- README.md | 17 +++++++++-- docs/features.md | 78 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 92 insertions(+), 3 deletions(-) create mode 100644 docs/features.md diff --git a/README.md b/README.md index 4acad64ddc..685b0e95b4 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Manage and run tasks in parallel. Orchestrate agents. Review changes. Ship value. -[Workflows](docs/workflow-tips.md) | [Run as a Service](docs/run-as-a-service.md) | [Roadmap](docs/roadmap.md) | [Contributing](CONTRIBUTING.md) | [Architecture](docs/ARCHITECTURE.md) | [Discord](https://discord.gg/gWdCPGcFCD) +[Features](docs/features.md) | [Workflows](docs/workflow-tips.md) | [Run as a Service](docs/run-as-a-service.md) | [Roadmap](docs/roadmap.md) | [Contributing](CONTRIBUTING.md) | [Architecture](docs/ARCHITECTURE.md) | [Discord](https://discord.gg/gWdCPGcFCD)

Kandev Demo @@ -39,9 +39,20 @@ Open source, multi-provider, no telemetry, not tied to any cloud. - **Workspace isolation** - Git worktrees prevent concurrent agents from conflicting - **Multi-repository tasks** - Span a single task across multiple repositories, with one worktree per repo, per-repo branches, per-repo PRs, and per-repo grouping in the Changes panel and review dialog - **Flexible runtimes** - Run agents as local processes, in isolated Docker containers, on remote servers via SSH, or in cloud executors like sprites.dev +- **Runtime settings** - Executor profiles, secrets, custom prompts, utility agents, voice mode, and resource metrics are configurable from Settings +- **Task-agent MCP** - Agents can create subtasks, target sibling repos, attach extra branches for multiple PRs, message other tasks, read conversations, and inspect related tasks +- **External MCP** - Manage Kandev from outside coding agents over streamable HTTP or SSE, with copyable config snippets for popular agent CLIs +- **Workflow portability** - Export and import workflows as portable YAML across workspaces or Kandev installs - **Session management** - Resume and review agent conversations +- **Shareable task snapshots** - Publish redacted task conversation snapshots as secret GitHub Gists, with preview and revoke controls - **Stats** - Track your productivity with stats on the completed tasks, agent turns, etc +See [docs/features.md](docs/features.md) for the full feature inventory, including settings, secrets, custom prompts, and MCP task capabilities. + +### In progress: Office mode + +We're working on **Office mode**, a feature-flagged autonomy layer for persistent agent teams. The direction is agent instances with roles and permissions, dashboards, inbox/approvals, routines, task delegation, skills, memory, cost tracking, budgets, and workspace config sync. We'll document Office as a supported feature after it is live. + ## Integrations

@@ -82,7 +93,7 @@ Connect Kandev to the tools your team already uses — pull issues into the kanb ### Bring your own TUI agents -There is support for running any agent as TUI inside a terminal. Just add the cli command in the agent profile settings and the task will start the agent inside a PTY terminal instead of using ACP. +Kandev can run any agent CLI as a TUI inside a terminal, even when it does not speak ACP. Add the command in agent profile settings and the task starts that agent inside a PTY terminal. CLI passthrough keeps the agent's native terminal UX available while still giving Kandev task tracking, worktrees, review, and session management. ## Supported Executors @@ -93,7 +104,7 @@ There is support for running any agent as TUI inside a terminal. Just add the cl | **SSH** | Runs the agent on a remote server over SSH | | **Sprites** | Runs the agent in a remote cloud environment via [sprites.dev](https://sprites.dev) | -Each executor uses git worktrees for workspace isolation, preventing concurrent agents from conflicting. +Executors support profiles for reusable runtime configuration: prepare scripts, environment variables, credentials, and settings. Worktree-based tasks can also attach multiple repositories or multiple branches from the same repository, which lets one task produce several PRs when the work needs it. ## Quick Start diff --git a/docs/features.md b/docs/features.md new file mode 100644 index 0000000000..26bd602878 --- /dev/null +++ b/docs/features.md @@ -0,0 +1,78 @@ +# Kandev Feature Guide + +This page expands the short feature list in the README without turning the README into a catalog. + +## Agent And Task Workflows + +- **Parallel task execution:** run and review multiple agent tasks at once. +- **Kanban and pipeline workflows:** define workflow steps, prompts, automations, and agent handoffs per step. +- **Workflow import/export:** export one workflow or every workflow in a workspace as portable YAML, then import it into another workspace or Kandev install. See [workflow-import-export.md](workflow-import-export.md). +- **Subtasks:** split work into child tasks that inherit the parent task's workspace, workflow, agent profile, executor, and repositories by default. +- **Multi-repository tasks:** attach several repositories to one task. Each repository gets its own worktree and is grouped separately in changes, review, and PR surfaces. +- **Multi-branch tasks:** attach multiple branches from the same repository to one task when the work needs to produce several PRs. +- **Task documents:** tasks can hold multiple markdown documents with revision history, including plans, specs, notes, reviews, and custom documents. +- **Task labels:** workspace labels are reusable, filterable, and visible on task cards and task detail. +- **Public share links:** publish a redacted task conversation snapshot as a secret GitHub Gist after previewing exactly what will be shared. Existing shares can be revoked. + +## Agent Interfaces + +- **ACP agents:** Kandev supports ACP-native and ACP-adapter agents such as Claude Code, Codex, GitHub Copilot, Gemini CLI, Amp, Auggie, OpenCode, Cursor, Qwen, Factory Droid, iFlow, Kilocode, Pi, Kimi, Kiro, Qoder, Trae, and Oh My Pi. +- **Bring-your-own TUI agents:** any agent CLI can run in a PTY terminal through CLI passthrough, even without ACP support. +- **Voice mode:** dictate chat prompts from the composer. Supported engines include browser Web Speech, local in-browser Whisper Web, and server-side Whisper. Settings include language, click-to-toggle or hold-to-talk activation, auto-send, Whisper model size, and keyboard shortcut. +- **Utility agents:** one-shot helpers can generate or improve prompt text, branch names, commit messages, commit descriptions, PR titles, PR descriptions, and session summaries. Users can choose a default model, override models per action, and add custom utility agents. +- **Custom prompts:** reusable prompts can be created in settings and invoked from chat. +- **Secrets:** named secrets can be stored once and reused by profiles or integrations without pasting values into every task. + +## Executors And Runtime + +- **Executor types:** run agents as local host processes, git worktrees, Docker containers, remote SSH sessions, or Sprites cloud environments. +- **Executor profiles:** save per-runtime configuration, including prepare scripts, environment variables, credentials, and profile-specific settings. +- **Worktree isolation:** concurrent agents work in isolated git worktrees so their changes do not collide. +- **Per-task repository setup:** repositories can copy selected ignored files, such as `.env` files, into newly created worktrees. +- **Resource monitor:** optionally show CPU, memory, disk, CPU temperature, and load metrics in desktop task and kanban topbars. Kandev can also collect execution-environment metrics for Docker, SSH, Sprites, and other remote runtimes. + +## Integrations And MCP + +- **Integrations:** GitHub, GitLab, Jira, Linear, Sentry, and Slack connect external work back into Kandev tasks. +- **External MCP:** Kandev exposes streamable HTTP and SSE MCP endpoints so external coding agents can manage Kandev from outside the app. Settings include copyable snippets for Claude Code, Cursor, Codex, Auggie CLI, OpenCode, and GitHub Copilot CLI. +- **Automatic session MCP:** agents launched normally inside Kandev receive the Kandev task MCP automatically. +- **Passthrough MCP:** passthrough agents can also use the Kandev MCP endpoint while keeping their native CLI interface. + +## What Task Agents Can Do Through Kandev MCP + +Agents running on regular kanban tasks receive a task-scoped MCP surface. The available tools let agents coordinate work without leaving Kandev: + +- **Discover workspace context:** list workspaces, workflows, workflow steps, repositories, agents, executor profiles, and tasks. +- **Work with multi-repo tasks:** task responses include attached repositories, base branches, checkout branches, and positions so agents can reason about each worktree separately. +- **Create tasks and subtasks:** create top-level tasks or child tasks, optionally auto-starting an agent. Subtasks inherit the parent workspace, workflow, agent profile, executor, and repositories unless the agent supplies an override. +- **Target sibling repositories:** create a subtask in a different repository while keeping it under the same parent task and workspace. +- **Coordinate dependencies:** create tasks with blocker relationships and inspect related parent, child, sibling, blocker, and blocked-by tasks. +- **Attach more branches:** add another `(repository, branch)` worktree to an existing worktree task. Use this for multiple PRs from one task, either in the same repository or across repositories. +- **Adjust diff bases:** update a task repository's base branch so changes, ahead/behind counts, and review context compare against the right target branch. +- **Move, archive, or delete tasks:** move tasks across workflow steps, including optional handoff prompts for the next agent, or clean up tasks when appropriate. +- **Message other tasks:** send a prompt to another task's primary session. Running tasks queue the message for the next turn; idle tasks receive it immediately; created sessions start with it. +- **Read conversations:** fetch a task's conversation history, with pagination and message-type filters. +- **Record structured plans:** create, read, update, and delete task plans. +- **Signal completion:** explicitly tell Kandev that a workflow step is complete, with summary, handoff notes, and blockers. +- **See associated PRs:** task-listing and related-task responses include associated GitHub pull requests when available, including PR number, URL, title, state, and merge time. + +## In Progress: Office Mode + +Office mode is currently feature-flagged and not documented as a live supported feature yet. The planned direction is a higher-level autonomy workspace with: + +- Persistent agent instances with roles, permissions, skills, instructions, memory, status, and executor preferences. +- Agent dashboards, run history, inbox items, approvals, and human review gates. +- Task delegation across agent teams, including parent/child task coordination. +- Routines and scheduler-driven recurring work. +- Cost tracking, model usage visibility, and budget guardrails. +- Workspace configuration import/export and sync for agent/team setup. + +We'll move Office into the live feature inventory after it ships. + +## System Management + +- **Feature toggles:** runtime feature flags can be viewed and overridden from Settings > System, with restart prompts when required. +- **Updates:** Kandev can check for newer releases and, in supported service installs, apply an update through the UI. +- **Backups and restore:** Kandev creates snapshots before version upgrades and supports manual snapshots, download, restore, and deletion from the system settings page. +- **Disk usage:** inspect storage used by worktrees, repositories, sessions, tasks, quick chat, and backups. +- **Logs, database status, about, and licenses:** system settings include operational views useful for self-hosted installs.