feat: update readme & agent TUI reliability (#239)
This commit is contained in:
+37
-12
@@ -1,32 +1,57 @@
|
||||
# Kandev
|
||||
|
||||
Kandev is a local-first AI execution platform for software development work. It pairs a kanban-style task surface with live agent orchestration, file/workspace access, and real-time streaming of changes.
|
||||
Manage tasks. Orchestrate agents. Review changes. Ship value.
|
||||
|
||||
## Start locally
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
npx kandev
|
||||
```
|
||||
|
||||
The launcher downloads the latest release bundle, starts the backend + web app, and opens your browser.
|
||||
Downloads the latest release, starts the backend + web app, and opens your browser. Data (worktrees, SQLite DB) is stored in `~/.kandev` by default.
|
||||
|
||||
## What you get
|
||||
## What You Get
|
||||
|
||||
- **Task-centric execution**: turn tasks into runnable sessions with streaming updates.
|
||||
- **Workspace control**: shell, file, and git access scoped to each task.
|
||||
- **Agent orchestration**: run different agent types and resume sessions.
|
||||
- **Change visibility**: review diffs and track state per task/session.
|
||||
- **Live UI**: WebSocket-driven updates across tasks, messages, and outputs.
|
||||
- **Multi-agent support** - Claude Code, Codex, GitHub Copilot, Gemini CLI, Amp, Auggie, OpenCode
|
||||
- **Integrated workspace** - Terminal, code editor with LSP, git changes, browser preview, and chat
|
||||
- **Kanban & pipeline views** - Organize tasks with opinionated workflows and gates
|
||||
- **CLI passthrough** - Drop into raw agent TUI mode for full terminal access
|
||||
- **Workspace isolation** - Git worktrees prevent concurrent agents from conflicting
|
||||
- **Session management** - Resume and review agent conversations
|
||||
|
||||
## Supported Agents
|
||||
|
||||
| Agent | Default Model | Protocol |
|
||||
|-------|--------------|----------|
|
||||
| **Claude Code** | Sonnet 4.5 | stream-json |
|
||||
| **Codex** | GPT-5.2 Codex | Codex |
|
||||
| **GitHub Copilot** | GPT-4.1 | Copilot SDK |
|
||||
| **Gemini CLI** | Gemini 3 Flash | ACP |
|
||||
| **Amp** | Smart Mode | stream-json |
|
||||
| **Auggie** | Sonnet 4.5 | ACP |
|
||||
| **OpenCode** | GPT-5 Nano | REST/SSE |
|
||||
|
||||
|
||||
> **Beta** - Under active development. Expect rough edges and breaking changes.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Node.js (for `npx`)
|
||||
- Git (for repository access)
|
||||
- Docker (optional; only needed for containerized agents)
|
||||
- Git
|
||||
- Docker (optional - needed for container runtimes)
|
||||
|
||||
## Platforms
|
||||
|
||||
- macOS (Intel + Apple Silicon)
|
||||
- Linux (x64)
|
||||
- Windows (x64) (not tested yet)
|
||||
- Windows (x64, WSL)
|
||||
|
||||
## Learn More
|
||||
|
||||
Open source, multi-provider, no telemetry, not tied to any cloud.
|
||||
|
||||
See the [GitHub repository](https://github.com/kdlbs/kandev) for architecture, vision, development setup, and contributing guidelines.
|
||||
|
||||
## License
|
||||
|
||||
[AGPL-3.0](https://github.com/kdlbs/kandev/blob/main/LICENSE)
|
||||
|
||||
Reference in New Issue
Block a user