Cut through the UI and drive your Planka boards from the terminal. This CLI lets you scan work, create cards, and stay on top of notifications with fast, scriptable commands.
- Keep momentum without context switching to the browser.
- Script common workflows (triage, cleanup, nightly status pulls).
- Work with Planka from any machine that has Python installed.
Requirements: A Planka account. For Homebrew installs, macOS + Homebrew. For source/pipx installs, Python 3.11+.
brew tap voydz/homebrew-tap
brew install planka-cli# Install from GitHub
pipx install git+https://github.com/voydz/planka-cliplanka-cli login --url https://planka.example --username alice --password secretplanka-cli status
planka-cli projects list
planka-cli boards listlogin stores credentials in a .env file next to the planka-cli binary (or next to
scripts/planka_cli.py when running from source). You can also set credentials via
environment variables:
export PLANKA_URL=https://planka.example
export PLANKA_USERNAME=alice
export PLANKA_PASSWORD=secretplanka-cli
planka-cli status
planka-cli login --url https://planka.example --username alice --password secret
planka-cli logout
planka-cli projects list
planka-cli boards list [PROJECT_ID]
planka-cli lists list <BOARD_ID>
planka-cli cards list <LIST_ID>
planka-cli cards show <CARD_ID>
planka-cli cards create <LIST_ID> "Card title" --description "Details"
planka-cli cards update <CARD_ID> --name "New title"
planka-cli cards delete <CARD_ID>
planka-cli notifications all
planka-cli notifications unreadDeveloper docs live in docs/. Release automation notes are in docs/tap-automation.md.
python3 -m venv .venv
source .venv/bin/activate
pip install -e .scripts/planka_cli.pyCLI entrypointdocs/supporting documentationpyproject.tomlpackaging metadataMakefilehelpers for setup and binary builds
make setup
make run
make build- Release workflow only builds the macOS binary.
- Release workflow assumes a GitHub release is already published.
- No signing/notarization or multi-platform release assets yet.