Skip to content

zeeshanejaz/kanbin

Repository files navigation

Kanbin

Go Version Node Version License PRs Welcome Live

Lightweight, ephemeral Kanban boards for humans and AI agents. Create a board instantly — no sign-up required — share the key, and let it expire when the work is done.

✨ Features

  • 🚀 Instant Setup: No registration, no login — just create and share
  • 🔑 Key-Based Access: Each board gets a unique access key
  • ⚡ Real-time Sync: Updates reflect instantly across all clients
  • 🎨 Drag & Drop: Intuitive drag-and-drop task management
  • 💻 CLI + Web: Use the web UI or command-line interface
  • 🤖 AI-Friendly: Perfect for AI agents tracking their own tasks
  • 📦 Self-Hostable: Deploy on your own infrastructure

Components

Component Language Description
backend/ Go REST API server
frontend/ React + TypeScript Web UI
cli/ Go Command-line interface

Installation

Homebrew (Coming Soon)

brew tap zeeshanejaz/tap
brew install kanbin

Scoop (Coming Soon)

scoop bucket add kanbin https://github.com/zeeshanejaz/scoop-bucket
scoop install kanbin

Winget (Coming Soon)

winget install zeeshanejaz.kanbin

Via Go

go install github.com/zeeshanejaz/kanbin/cli/cmd/kanbin@latest

Manual Download

Download the latest binaries for Windows, macOS, and Linux from the GitHub Releases page.

Quickstart

Prerequisites

Setup

# 1. Install all dependencies
task setup

# 2. Configure environment
cp .env.example .env
# Edit .env with your database URL and other settings

# 3. Start the development stack
task dev

The frontend dev server starts on http://localhost:5173 and proxies API requests to the backend on http://localhost:8080.

Common Commands

Command Description
task setup Install Go and npm dependencies
task dev Start backend + frontend in dev mode
task build Build all components to bin/
task test Run all tests
task lint Lint all components
task clean Remove build artifacts

CLI Usage

Kanbin includes a command-line interface available as both kanbin and the shorthand kb. If you've installed it via a package manager or go install, it will be in your PATH. If you've built it from source, the binaries are located in the bin/ directory.

Backend Server URL

By default, the CLI connects to the production server at https://kanbin.app/api. You can override this in two ways:

  1. Global Flag: Use the --server (or -s) flag.
    kb --server http://localhost:8080/api board view <KEY>
  2. Environment Variable: Set the KANBIN_URL variable.
    export KANBIN_URL=http://localhost:8080/api
    kb board view <KEY>

Basic Commands

# General help
kb --help

# Create a new key-based anonymous board
kb board create "My CLI Board"

# View a board and its tasks
kb board view <BOARD_KEY>

# Add a new task to a board
kb task add "Implement auth" --board <BOARD_KEY>

Documentation

Project Specifications

See .specs/ for the project constitution, product specifications, and MVP delivery plan.

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines on:

  • Setting up your development environment
  • Code style and standards
  • Submitting pull requests
  • Reporting issues

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

About

Ephemeral Kanban boards for humans and AI agents. No sign-up — just create, share a key, and go. Includes a web UI, Go REST API, and CLI.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors