vibe-kanban README

The project's README from github.com/BloopAI/vibe-kanban. As one markdown file: README.md.

Vibe Kanban Logo

Get 10X more out of Claude Code, Gemini CLI, Codex, Amp and other coding agents...

npm Build status Ask DeepWiki

Vibe Kanban is sunsetting. Read the announcement.

Overview

In a world where software engineers spend most of their time planning and reviewing coding agents, the most impactful way to ship more is to get faster at planning and review.

Vibe Kanban is built for this. Use kanban issues to plan work, either privately or with your team. When you're ready to begin, create workspaces where coding agents can execute.

One command. Describe the work, review the diff, ship it.

npx vibe-kanban

Installation

Make sure you have authenticated with your favourite coding agent. A full list of supported coding agents can be found in the docs. Then in your terminal run:

npx vibe-kanban

Documentation

Head to the website for the latest documentation and user guides.

Self-Hosting

Want to host your own Vibe Kanban Cloud instance? See our self-hosting guide.

Support

We use GitHub Discussions for feature requests. Please open a discussion to create a feature request. For bugs please open an issue on this repo.

Contributing

We would prefer that ideas and changes are first raised with the core team via GitHub Discussions or Discord, where we can discuss implementation details and alignment with the existing roadmap. Please do not open PRs without first discussing your proposal with the team.

Development

Prerequisites

Additional development tools:

cargo install cargo-watch
cargo install sqlx-cli

Install dependencies:

pnpm i

Running the dev server

pnpm run dev

This will start the backend and web app. A blank DB will be copied from the dev_assets_seed folder.

Building the web app

To build just the web app:

cd packages/local-web
pnpm run build

Build from source (macOS)

  1. Run ./local-build.sh
  2. Test with cd npx-cli && node bin/cli.js

Environment Variables

The following environment variables can be configured at build time or runtime:

Variable Type Default Description
POSTHOG_API_KEY Build-time Empty PostHog analytics API key (disables analytics if empty)
POSTHOG_API_ENDPOINT Build-time Empty PostHog analytics endpoint (disables analytics if empty)
PORT Runtime Auto-assign Production: Server port. Dev: Frontend port (backend uses PORT+1)
BACKEND_PORT Runtime 0 (auto-assign) Backend server port (dev mode only, overrides PORT+1)
FRONTEND_PORT Runtime 3000 Frontend dev server port (dev mode only, overrides PORT)
HOST Runtime 127.0.0.1 Backend server host
MCP_HOST Runtime Value of HOST MCP server connection host (use 127.0.0.1 when HOST=0.0.0.0 on Windows)
MCP_PORT Runtime Value of BACKEND_PORT MCP server connection port
DISABLE_WORKTREE_CLEANUP Runtime Not set Disable all git worktree cleanup including orphan and expired workspace cleanup (for debugging)
VK_ALLOWED_ORIGINS Runtime Not set Comma-separated list of origins that are allowed to make backend API requests (e.g., https://my-vibekanban-frontend.com)
VK_SHARED_API_BASE Runtime Not set Base URL for the remote/cloud API used by the local desktop app
VK_SHARED_RELAY_API_BASE Runtime Not set Base URL for the relay API used by tunnel-mode connections
VK_TUNNEL Runtime Not set Enable relay tunnel mode when set (requires relay API base URL)

Build-time variables must be set when running pnpm run build. Runtime variables are read when the application starts.

Self-Hosting with a Reverse Proxy or Custom Domain

When running Vibe Kanban behind a reverse proxy (e.g., nginx, Caddy, Traefik) or on a custom domain, you must set the VK_ALLOWED_ORIGINS environment variable. Without this, the browser's Origin header won't match the backend's expected host, and API requests will be rejected with a 403 Forbidden error.

Set it to the full origin URL(s) where your frontend is accessible:

# Single origin
VK_ALLOWED_ORIGINS=https://vk.example.com

# Multiple origins (comma-separated)
VK_ALLOWED_ORIGINS=https://vk.example.com,https://vk-staging.example.com

Remote Deployment

When running Vibe Kanban on a remote server (e.g., via systemctl, Docker, or cloud hosting), you can configure your editor to open projects via SSH:

  1. Access via tunnel: Use Cloudflare Tunnel, ngrok, or similar to expose the web UI
  2. Configure remote SSH in Settings → Editor Integration:
    • Set Remote SSH Host to your server hostname or IP
    • Set Remote SSH User to your SSH username (optional)
  3. Prerequisites:
    • SSH access from your local machine to the remote server
    • SSH keys configured (passwordless authentication)
    • VSCode Remote-SSH extension

When configured, the "Open in VSCode" buttons will generate URLs like vscode://vscode-remote/ssh-remote+user@host/path that open your local editor and connect to the remote server.

See the documentation for detailed setup instructions.

vibe-kanban (BloopAI/vibe-kanban)

Searching Database…

这是什么?一个围绕编程智能体打造的看板:你把工作拆成 issue 来规划,让 Claude Code 这类智能体在隔离的工作区里运行,审查它们改动的代码差异,然后交付上线。
它是网站、桌面应用,还是命令行工具?一个本地 Web 应用:npm CLI 会启动一个服务器,你在浏览器里使用看板。也可以自托管在自己的服务器上。
我怎么把它跑起来?先给你喜欢的编程智能体完成认证,然后用一条终端命令启动它;剩下的看官网文档就行。
它能驱动哪些编程智能体?十多个:Claude Code、Codex、Gemini CLI、GitHub Copilot、Amp、Cursor、OpenCode、Droid、CCR 和 Qwen Code——可以随时切换。
有什么需要犹豫的理由吗?README 宣布 Vibe Kanban 即将停止维护——在投入时间之前,值得先查一下项目目前的状态。
这是给个人开发者还是团队用的?都可以——看板既可以私下自己用,也可以和团队一起用,共同规划和分配 issue。
我能把它部署到服务器上,而不是放在自己的笔记本上吗?可以——有自托管指南,远程部署可以通过 systemctl、Docker 或云主机完成,再通过 Cloudflare Tunnel 或 ngrok 这类隧道来访问。如果放在反向代理后面,必须设置 VK_ALLOWED_ORIGINS,否则 API 请求会返回 403。
它会向第三方服务器发送什么?统计数据通过 PostHog 上报,构建时的 PostHog API key 环境变量留空即可禁用统计。除此之外应用都在本地运行,自托管的话数据也留在你自己的基础设施里。
为什么不直接用一个普通看板,而要专门做这个?因为当代码由智能体来写之后,工程师的瓶颈就转移到了规划和审查它们的工作上——这个工具就是专门为了让这两步更快而做的。
我能在不离开这个工具的情况下预览智能体正在构建的应用吗?可以——内置了浏览器预览,还带开发者工具、检查模式和设备模拟。
我能用自己的编辑器打开项目吗,包括项目跑在远程服务器上的情况?可以——在 Settings → Editor Integration 里配置远程 SSH 主机和用户;配上免密 SSH 密钥和 VSCode Remote-SSH 扩展后,'Open in VSCode' 按钮就能直接在服务器上打开项目。
What are similar projects?1code, shipyard, agent-orchestrator, epiq, emdash, vicoa, Archon, fractal
Creator
BloopAI
Size
101.6 MB
Stars
28.4K
Age
1y
Commits · 90 Days