ba919305c2
Features: - Unified Go binary running Task Service, Agent Manager, and Orchestrator - SQLite persistence for boards, columns, and tasks - Docker-based agent execution with ACP message streaming - Augment Agent integration with session resumption support - RESTful API for all operations (port 8080) - In-memory event bus for service communication Architecture: - cmd/kandev: Single entry point for all services - internal/task: Task, board, and column management - internal/agent: Docker container lifecycle and ACP streaming - internal/orchestrator: Agent coordination and monitoring - internal/events: In-memory pub/sub event bus Documentation: - README.md: Project overview and quick start - docs/ARCHITECTURE.md: System architecture (current + planned) - docs/GETTING_STARTED.md: Development setup guide - docs/IMPLEMENTATION_PLAN.md: Original microservices plan - backend/NEXT_STEPS.md: Development roadmap
190 lines
6.0 KiB
Markdown
190 lines
6.0 KiB
Markdown
# Kandev - Kanban Board with AI Agent Orchestration
|
|
|
|
A Kanban board system that integrates AI agent orchestration capabilities with **real-time Agent Communication Protocol (ACP) streaming**, allowing tasks to be automatically executed by AI agents running in isolated Docker containers.
|
|
|
|
## Overview
|
|
|
|
Kandev combines traditional Kanban task management with automated AI agent execution and real-time feedback streaming. Users create tasks on a Kanban board, and when configured with an AI agent type, the system automatically launches Docker containers to execute those tasks against specified code repositories. **Real-time progress, logs, and results are streamed from agents to the frontend via WebSocket connections.**
|
|
|
|
### Key Features
|
|
|
|
- **Kanban Board Management**: Create and manage tasks across multiple boards with columns
|
|
- **AI Agent Orchestration**: Launch AI agents (Augment Agent) to execute tasks
|
|
- **Real-Time ACP Streaming**: Live progress updates, logs, and results streamed from agents
|
|
- **Session Resumption**: Agents can resume previous conversations using session IDs
|
|
- **Docker Isolation**: Each agent runs in an isolated Docker container with resource limits
|
|
- **Repository Integration**: Agents can work on code repositories with host credentials
|
|
- **Host Credential Mounting**: Secure read-only mounting of SSH keys and Git credentials
|
|
- **SQLite Persistence**: Lightweight file-based database for task and board storage
|
|
- **Local Deployment**: Designed for client machines with minimal dependencies
|
|
|
|
## Architecture
|
|
|
|
The system runs as a **unified Go binary** that includes:
|
|
|
|
- **Task Service**: Manages tasks, boards, and columns with SQLite persistence
|
|
- **Agent Manager**: Manages Docker container lifecycle and ACP message streaming
|
|
- **Orchestrator**: Coordinates agent launches and monitors execution
|
|
- **HTTP API**: RESTful endpoints for all operations (Port 8080)
|
|
|
|
### Agent Communication Protocol (ACP)
|
|
|
|
ACP is a JSON-based streaming protocol that enables real-time communication between AI agents and the backend:
|
|
|
|
```
|
|
Agent Container (stdout) → Agent Manager → Event Bus → API
|
|
```
|
|
|
|
**Message Types**: `progress`, `log`, `result`, `error`, `status`, `heartbeat`
|
|
|
|
See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for detailed architecture documentation.
|
|
|
|
## Supported Agent Types
|
|
|
|
1. **Augment Agent** (`augment-agent`)
|
|
- Uses Auggie CLI for code analysis, generation, debugging, refactoring
|
|
- Native ACP support via stdout JSON streaming
|
|
- Session resumption for multi-turn conversations
|
|
|
|
## Technology Stack
|
|
|
|
- **Backend**: Go 1.21+
|
|
- **Database**: SQLite (with WAL mode)
|
|
- **Container Runtime**: Docker
|
|
- **Web Framework**: Gin
|
|
- **Logging**: Zap (structured logging)
|
|
- **Deployment**: Single binary for client machines
|
|
|
|
## Quick Start
|
|
|
|
### Prerequisites
|
|
|
|
- Go 1.21 or higher
|
|
- Docker
|
|
- Augment CLI credentials (`~/.augment/session.json`)
|
|
|
|
### Build and Run
|
|
|
|
```bash
|
|
cd backend
|
|
|
|
# Build the binary
|
|
make build
|
|
|
|
# Run the server (creates kandev.db in current directory)
|
|
./bin/kandev
|
|
|
|
# Or specify a custom database path
|
|
KANDEV_DB_PATH=/path/to/kandev.db ./bin/kandev
|
|
```
|
|
|
|
### API Usage
|
|
|
|
```bash
|
|
# Create a board
|
|
curl -X POST http://localhost:8080/api/v1/boards \
|
|
-H "Content-Type: application/json" \
|
|
-d '{"name": "My Project", "description": "Project tasks"}'
|
|
|
|
# Create a column
|
|
curl -X POST http://localhost:8080/api/v1/boards/{board_id}/columns \
|
|
-H "Content-Type: application/json" \
|
|
-d '{"name": "To Do"}'
|
|
|
|
# Create a task
|
|
curl -X POST http://localhost:8080/api/v1/boards/{board_id}/columns/{column_id}/tasks \
|
|
-H "Content-Type: application/json" \
|
|
-d '{"title": "Fix login bug", "description": "Users cannot login"}'
|
|
|
|
# Launch an agent for a task
|
|
curl -X POST http://localhost:8080/api/v1/agents/launch \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"task_id": "{task_id}",
|
|
"agent_type": "augment-agent",
|
|
"workspace_path": "/path/to/project",
|
|
"env": {
|
|
"AUGMENT_SESSION_AUTH": "...",
|
|
"TASK_DESCRIPTION": "What is 2+2?"
|
|
}
|
|
}'
|
|
|
|
# Check agent status
|
|
curl http://localhost:8080/api/v1/agents/{agent_id}/status
|
|
```
|
|
|
|
See [backend/NEXT_STEPS.md](backend/NEXT_STEPS.md) for detailed API reference and next steps.
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
kandev/
|
|
├── backend/
|
|
│ ├── cmd/kandev/ # Unified binary entry point
|
|
│ ├── internal/
|
|
│ │ ├── agent/ # Agent manager (docker, lifecycle, registry, api)
|
|
│ │ ├── task/ # Task service (models, repository, service, api)
|
|
│ │ ├── orchestrator/ # Orchestrator service
|
|
│ │ ├── events/ # In-memory event bus
|
|
│ │ └── common/ # Shared utilities (logger, config)
|
|
│ ├── dockerfiles/ # Agent container Dockerfiles
|
|
│ ├── Makefile
|
|
│ └── NEXT_STEPS.md # Development roadmap
|
|
├── docs/ # Architecture and planning docs
|
|
├── migrations/ # Database migrations (future)
|
|
├── deployments/ # Deployment configs
|
|
└── scripts/ # Utility scripts
|
|
```
|
|
|
|
## Configuration
|
|
|
|
| Environment Variable | Default | Description |
|
|
|---------------------|---------|-------------|
|
|
| `KANDEV_DB_PATH` | `./kandev.db` | SQLite database file path |
|
|
| `PORT` | `8080` | HTTP server port |
|
|
|
|
## Development
|
|
|
|
```bash
|
|
cd backend
|
|
|
|
# Build
|
|
make build
|
|
|
|
# Run tests
|
|
make test
|
|
|
|
# Format code
|
|
go fmt ./...
|
|
|
|
# Lint
|
|
go vet ./...
|
|
```
|
|
|
|
## Project Status
|
|
|
|
✅ **Core Features Working**
|
|
|
|
- [x] SQLite persistence for boards, columns, and tasks
|
|
- [x] Agent lifecycle management with Docker
|
|
- [x] ACP message streaming from containers
|
|
- [x] Session resumption for multi-turn agent conversations
|
|
- [x] RESTful API for all operations
|
|
|
|
🚧 **In Progress**
|
|
|
|
- [ ] WebSocket support for real-time streaming to frontend
|
|
- [ ] Authentication and authorization
|
|
- [ ] Frontend UI
|
|
|
|
See [backend/NEXT_STEPS.md](backend/NEXT_STEPS.md) for the complete roadmap.
|
|
|
|
## License
|
|
|
|
[To be determined]
|
|
|
|
## Acknowledgments
|
|
|
|
Built with Go and inspired by modern DevOps practices and AI-assisted development workflows.
|
|
|