Carlos Florêncio
85 lines
2.8 KiB
Markdown
85 lines
2.8 KiB
Markdown
# Kandev
|
|
|
|
Manage tasks. Orchestrate agents. Review changes. Ship value.
|
|
|
|
## Quick Start
|
|
|
|
### Homebrew
|
|
|
|
```bash
|
|
brew install kdlbs/kandev/kandev
|
|
kandev
|
|
```
|
|
|
|
### NPX (requires npm 7+)
|
|
|
|
```bash
|
|
npx kandev@latest
|
|
```
|
|
|
|
Either install path resolves a platform-matched runtime (Go backend, agentctl, and static Vite web assets), launches the backend, and opens your browser. Data (worktrees, SQLite DB) is stored in `~/.kandev` by default.
|
|
|
|
## Version and Updates
|
|
|
|
The package manager owns the runtime version. `kandev@X.Y.Z` ships with the matching runtime.
|
|
|
|
- **Update via Homebrew**: `brew upgrade kandev`
|
|
- **Update via npm/npx**: `npx kandev@latest` or `npm install -g kandev@latest`
|
|
- **Print CLI version**: `kandev --version`
|
|
|
|
## Run as a Service
|
|
|
|
Install kandev as a systemd (Linux) or launchd (macOS) service so it auto-starts and stays running across reboots:
|
|
|
|
```bash
|
|
kandev service install # user mode (laptop, single-user)
|
|
sudo kandev service install --system # system mode (VPS, shared host)
|
|
```
|
|
|
|
See [docs/run-as-a-service.md](../../docs/run-as-a-service.md) for the full guide — user vs system mode comparison, update workflow, troubleshooting.
|
|
|
|
## What You Get
|
|
|
|
- **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 (only for `npx` / npm-based installs and development tooling)
|
|
- Git
|
|
- Docker (optional - needed for container runtimes)
|
|
|
|
## Platforms
|
|
|
|
- macOS (Intel + Apple Silicon)
|
|
- Linux (x64)
|
|
- 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)
|