pkanban

pkanban

A CLI-first Kanban board for humans and AI agents. (The "p" is silent, like in "pneumonia".)

Most users will connect to our hosted service at pkanban.pearachute.com. If you want to run your own server, see the Self-Hosting section below.

Quick Start

macOS, Linux, WSL:

curl -fsSL https://pkanban.pearachute.com/install.sh | sh

Windows PowerShell:

irm https://pkanban.pearachute.com/install.ps1 | iex

Windows CMD:

curl -fsSL https://pkanban.pearachute.com/install.cmd -o install.cmd && install.cmd && del install.cmd

The installer uses uv or pipx if you have one, and installs uv (which brings its own Python) if you don't. Already have Python? pip install pkanban works too.

The CLI connects to the hosted service at https://pkanban.pearachute.com by default, so you can log in right away:

pkanban login

Your browser opens on an approval page; click Approve and the terminal is signed in. Nothing secret is typed into the terminal, so this is also how to sign in an AI agent (pkanban login --no-wait, approve, then pkanban login again). Prefer a password? pkanban login <username> prompts for one.

Self-hosting? Point the CLI at your own server first with pkanban config --url http://localhost:8000 — see Self-Hosting.

Common Commands

# List your boardspkanban board list
# Create a new boardpkanban board create "My Project"
# View a board with its columns and cardspkanban board get 1
# Add a columnpkanban column create 1 "To Do" 0
# Add a cardpkanban card create 1 "First task" --description "Getting started"
# Share a board with a team (read, write or admin)pkanban share 1 <team-id> -p write

API Keys

For automation, CI/CD, or giving access to agents, use API keys instead of passwords:

# Create a key (shown only once!)pkanban apikey create "CI Agent"
# Save it once; subsequent commands use it automaticallypkanban apikey save pkanban_abc123...pkanban board list
# Or pass it per commandpkanban --api-key pkanban_abc123... board list

API keys can be revoked and reactivated at any time. They're stored securely (bcrypt-hashed) and track their last usage.

Scripting: JSON output

--json makes any command print the raw API response instead of formatted text, so scripts never have to scrape prose for values like IDs:

pkanban board create "Roadmap" --jsonpkanban board get 1 --json | jq '.columns[] | {id, name}'

PKANBAN_OUTPUT=json does the same for a whole run:

export PKANBAN_OUTPUT=json

The flag works in either position (pkanban --json board list and pkanban board list --json are equivalent). In JSON mode stdout carries only the response, and errors go to stderr as {"error": ..., "status": ...} with a non-zero exit code — so stdout is always safe to pipe into a parser.

pkanban login --json deliberately omits the access token: it is already saved to ~/.pkanban.yaml, and stdout is what CI logs capture.

Command Reference

Self-Hosting

Want to run your own server? Here's how:

1. Clone and setup

git clone https://github.com/japherwocky/pkanban.gitcd pkanbanpython -m venv venvsource venv/bin/activate  # Windows: venv\Scripts\activatepip install -r backend/requirements.txtcd frontend && npm install && cd ..

2. Initialize and run

python manage.py initpython manage.py user-create admin mypassword --adminpython manage.py server

The server runs at http://localhost:8000 by default.

3. Connect the CLI

The CLI defaults to the hosted service, so point it at your local server first, then log in (you'll be prompted for the password):

pkanban config --url http://localhost:8000pkanban login admin

Development

# Run the server with auto-reloadpython manage.py server
# Run frontend dev server (hot reload)cd frontend && npm run dev
# Run testspython -m pytest backend/tests/

Database commands

python manage.py init          # Create tablespython manage.py wipe          # Drop and recreate tablespython manage.py status        # Check database statuspython manage.py user-create <user> <pass> [--admin]

API Reference

The backend exposes a REST API at /api/:

Authentication

• POST /api/token - Login (returns JWT)
• X-API-Key header - Alternative auth via API key

API Keys

• GET /api/api-keys - List your keys
• POST /api/api-keys - Create a key
• DELETE /api/api-keys/{id} - Revoke a key
• POST /api/api-keys/{id}/activate - Reactivate a key

Boards

• GET /api/boards - List accessible boards
• POST /api/boards - Create a board
• GET /api/boards/{id} - Get board details (archived cards hidden; ?include_archived=true adds them)
• POST /api/boards/{id} - Update board
• DELETE /api/boards/{id} - Delete board

Columns

• POST /api/columns - Create column
• PUT /api/columns/{id} - Update column
• DELETE /api/columns/{id} - Delete column

Cards

• GET /api/cards/{id} - Get one card with its description and comments
• POST /api/cards - Create card
• PUT /api/cards/{id} - Update card
• DELETE /api/cards/{id} - Delete card
• POST /api/cards/{id}/archive - Archive a card: hidden from board views, still found by search
• POST /api/cards/{id}/unarchive - Bring it back, at the bottom of its column

Comments

• GET /api/cards/{id}/comments - List a card's comments
• POST /api/comments - Comment on a card (card_id, content)
• PUT /api/comments/{id} - Edit a comment (author only)
• DELETE /api/comments/{id} - Delete a comment (author only)
• GET /api/search?q=... - Search card titles and descriptions on every board you can open (board_id, limit optional)

For multi-tenant organization details, see docs/multi-tenant.md.