Skip to content

PHY041/Canban.AI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

17 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

CanBan.AI

AI-powered Kanban board with automatic task prioritization, built for managing multiple workstreams efficiently.

πŸ–₯️ Desktop App (Recommended)

Download the latest release for your platform:

  • macOS (Apple Silicon): CanBan.AI-x.x.x-arm64.dmg
  • Windows: CanBan.AI-Setup-x.x.x.exe (coming soon)
  • Linux: CanBan.AI-x.x.x.AppImage (coming soon)

⚠️ macOS Users: First Launch

macOS may block the app because it's unsigned. Fix:

# Option 1: Right-click the app β†’ Open β†’ Open (first time only)

# Option 2: Remove quarantine
xattr -cr /Applications/CanBan.AI.app

πŸš€ First-Time Setup (5 minutes)

Step 1: Get Your API Keys (all free!)

You need 3 things. Here's exactly where to get them:

What Where to Get Time
Supabase URL supabase.com β†’ New Project β†’ Settings β†’ API 2 min
Supabase Key Same page, copy "anon public" key -
OpenAI Key platform.openai.com/api-keys β†’ Create new key 1 min
πŸ“– Detailed instructions (click to expand)

Get Supabase URL & Key

  1. Go to supabase.com β†’ Sign up (free, no credit card)
  2. Click "New Project" β†’ name it "canban" β†’ set a password β†’ Create
  3. Wait ~2 minutes for setup
  4. Click Settings (gear icon, bottom left) β†’ API
  5. Copy these two values:
    • Project URL: looks like https://abcdefg.supabase.co
    • anon public key: the long string starting with eyJ...

Get OpenAI API Key

  1. Go to platform.openai.com β†’ Sign up
  2. Click API Keys (left sidebar) β†’ "Create new secret key"
  3. Copy the key (starts with sk-...)
  4. Note: New accounts get ~$5 free credits

Step 2: Set Up Database

  1. In Supabase, go to SQL Editor (left sidebar)
  2. Copy everything from backend/supabase_schema.sql
  3. Paste into SQL Editor β†’ Click Run
  4. You should see "Success" βœ“

Step 3: Enter Keys in App

  1. Open CanBan.AI
  2. Click the βš™οΈ Settings button (top right)
  3. Paste your 3 keys
  4. Click Save Settings
  5. Restart the app

πŸŽ‰ Done! Start managing your tasks with AI!


✨ Features

Feature Description
AI Priority Click "AI Prioritize" β†’ AI analyzes deadlines & complexity β†’ auto-ranks tasks
Paste & Extract Paste emails, syllabi, meeting notes β†’ AI extracts tasks automatically
Daily Briefing AI summary of your priorities and what to focus on
Claude Code Agent Let Claude Code work on your tasks in isolated git worktrees
Multi-Board Separate boards for Work, School, Projects, etc.
Drag & Drop Move cards between To Do / In Progress / Done

πŸ€– Claude Code Agent Integration

CanBan.AI integrates with Claude Code to let AI work on your coding tasks directly.

Prerequisites

  1. Install Claude Code CLI:
    npx @anthropic-ai/claude-code
  2. Complete authentication (follow the prompts to log in)

How It Works

  1. Set repo path on your board (Settings β†’ Repository Path)
  2. Click "Start Agent" on any card
  3. Claude Code runs in an isolated git worktree (won't affect your main branch)
  4. Watch progress in real-time via the Agent Panel
  5. Multi-turn conversation: Send follow-up messages after Claude completes
  6. Review & merge the changes when satisfied

Agent Features

  • Git Worktree Isolation: Each task runs in its own branch/directory
  • Real-time Streaming: See Claude's output as it works
  • Multi-turn Chat: Continue conversations with --resume
  • Diff Viewer: Review all changes before merging

πŸ› οΈ For Developers

Run from Source

# Clone
git clone https://github.com/PHY041/Canban.AI.git
cd Canban.AI

# Install
npm install
cd backend && pip install -r requirements.txt && cd ..

# Run (opens Electron app with hot-reload)
./start.sh desktop

Build Desktop App

# Install PyInstaller first
pip install pyinstaller

# Build for your platform
./start.sh build

# Output: release/CanBan.AI-x.x.x.dmg

Tech Stack

  • Frontend: React 18, TypeScript, Tailwind CSS, dnd-kit (port 5173)
  • Backend: FastAPI (Python), Supabase (port 51723)
  • AI: OpenAI GPT-4o-mini
  • Desktop: Electron

πŸ“‘ API Endpoints

Endpoint Description
GET /api/boards List all boards
POST /api/boards Create board
GET /api/cards/board/:id List cards in board
POST /api/cards Create card
POST /api/ai/prioritize AI prioritization
POST /api/ai/extract-tasks Extract tasks from text
GET /api/ai/daily-briefing Daily AI briefing
GET /api/settings Load saved settings
POST /api/settings Save settings to ~/.canban-ai/.env

Agent Endpoints

Endpoint Description
GET /api/agents/status Check if Claude Code CLI is available
POST /api/agents/start Start agent for a card
GET /api/agents/session/:id Get session status and output
POST /api/agents/message Send follow-up message (uses --resume)
GET /api/agents/stream/:id SSE stream for real-time output
POST /api/agents/cancel/:id Cancel running agent

Git Endpoints

Endpoint Description
GET /api/git/diff/:cardId Get diff for card's worktree
GET /api/git/worktree/:cardId Get worktree info
POST /api/git/merge Merge worktree changes to main

πŸ™ Acknowledgments

The Claude Code agent integration pattern was inspired by Vibe Kanban by @dillionverma. Their implementation of Claude Code + git worktree isolation was the foundation for our agent executor service.


πŸ“„ License

MIT

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors