home / skills / openclaw / skills / planka-cli

planka-cli skill

safe

This skill helps you manage Planka Kanban projects, boards, lists, and cards via a Python CLI wrapper for streamlined workflow.

npx playbooks add skill openclaw/skills --skill planka-cli

Review the files below or copy the command above to add this skill to your agents.

Files (2)

SKILL.md

2.3 KB

---
name: planka
description: Manage Planka (Kanban) projects, boards, lists, cards, and notifications via a custom Python CLI.
metadata: {"clawdbot":{"emoji":"📋","requires":{"bins":["planka-cli"]}}}
---

# Planka CLI

This skill provides a CLI wrapper around the `plankapy` library to interact with a Planka instance.

## Setup

1.  **Install via Homebrew tap:**
    ```bash
    brew tap voydz/homebrew-tap
    brew install planka-cli
    ```

2.  **Configuration:**
    Use the `login` command to store credentials:
    ```bash
    planka-cli login --url https://planka.example --username alice --password secret
    # or: python3 scripts/planka_cli.py login --url https://planka.example --username alice --password secret
    ```

## Usage

Run the CLI with the installed `planka-cli` binary:

```bash
# Show help
planka-cli

# Check connection
planka-cli status

# Login to planka instance
planka-cli login --url https://planka.example --username alice --password secret

# Remove stored credentials
planka-cli logout

# List Projects
planka-cli projects list

# List Boards (optionally by project ID)
planka-cli boards list [PROJECT_ID]

# List Lists in a Board
planka-cli lists list <BOARD_ID>

# List Cards in a List
planka-cli cards list <LIST_ID>

# Create a Card
planka-cli cards create <LIST_ID> "Card title"

# Update a Card
planka-cli cards update <CARD_ID> --name "New title"
planka-cli cards update <CARD_ID> --list-id <LIST_ID>
planka-cli cards update <CARD_ID> --list-id <LIST_ID> --position top

# Delete a Card
planka-cli cards delete <CARD_ID>

# Notifications
planka-cli notifications all
planka-cli notifications unread
```

## Examples

**List all boards:**
```bash
planka-cli boards list
```

**Show cards in list ID 1619901252164912136:**
```bash
planka-cli cards list 1619901252164912136
```

**Create a card in list ID 1619901252164912136:**
```bash
planka-cli cards create 1619901252164912136 "Ship CLI"
```

**Move a card to another list:**
```bash
planka-cli cards update 1619901252164912137 --list-id 1619901252164912136
```

**Move a card to another list and pin it to the top:**
```bash
planka-cli cards update 1619901252164912137 --list-id 1619901252164912136 --position top
```

**Mark a card done by updating its name:**
```bash
planka-cli cards update 1619901252164912137 --name "Done: Ship CLI"
```

Overview

This skill provides a Python-based CLI to manage Planka (Kanban) instances from the terminal. It wraps the plankapy library so you can authenticate, browse projects/boards/lists/cards, create or move cards, and view notifications without opening a browser. It is ideal for scripting, backups, or quick board edits.

How this skill works

The CLI stores credentials via a login command and communicates with a Planka server using plankapy API calls. Commands map to Planka concepts (projects, boards, lists, cards, notifications) and allow listing, creating, updating, moving, and deleting resources. Output is designed for human reading and shell scripting, so it can be combined with other tools or cron jobs.

When to use it

Quickly create or update cards from the terminal or scripts.
Automate exports, backups, or bulk updates against a Planka instance.
Inspect board, list, or card structure without using the web UI.
Integrate Planka actions into CI/CD or developer workflows.
Monitor notifications from a central script or service.

Best practices

Use the login command to securely store credentials before running other commands.
Script safe operations (list → filter → act) to avoid accidental deletes.
Pass explicit IDs for boards, lists, and cards to ensure deterministic changes.
Keep automated tokens or credentials in a restricted environment and rotate them regularly.
Pipe and parse CLI output in scripts rather than relying on interactive formatting.

Example use cases

List all boards to generate a report: planka-cli boards list
Create a task from a commit hook: planka-cli cards create <LIST_ID> "Fix bug #123"
Move completed tasks to Done and pin them: planka-cli cards update <CARD_ID> --list-id <DONE_LIST_ID> --position top
Bulk audit lists and produce CSV for backup by scripting cards list and parsing output
Poll notifications unread to trigger alerts in a chatops workflow: planka-cli notifications unread

FAQ

How do I authenticate to my Planka instance?

Use planka-cli login --url <PLANKA_URL> --username <USER> --password <PASS> to store credentials for subsequent commands.

Can I script card creation and movement?

Yes. Commands like cards create and cards update accept IDs and flags, so they can be used in shell scripts or automation pipelines.

Is there a way to remove stored credentials?

Yes. Run planka-cli logout to clear stored credentials from the local environment.