Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/fulsomenko/kanban/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Column commands allow you to create and manage columns on kanban boards. Columns represent stages in your workflow and can have WIP (Work In Progress) limits.

Commands

Create a Column

Create a new column on a board:
kanban column create --board-id <BOARD_ID> --name <NAME> [--position <POSITION>]
--board-id
uuid
required
The UUID of the board.
--name
string
required
The name of the column.
--position
integer
Position of the column (0-indexed). If not specified, the column is added at the end.

Example

kanban column create \
  --board-id 550e8400-e29b-41d4-a716-446655440000 \
  --name "In Progress" \
  --position 1

Output

{
  "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
  "board_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "In Progress",
  "position": 1,
  "wip_limit": null,
  "created_at": "2024-03-05T12:00:00Z",
  "updated_at": "2024-03-05T12:00:00Z"
}

List Columns

List all columns for a board:
kanban column list --board-id <BOARD_ID>
--board-id
uuid
required
The UUID of the board.

Example

kanban column list --board-id 550e8400-e29b-41d4-a716-446655440000

Output

[
  {
    "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "board_id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Todo",
    "position": 0,
    "wip_limit": null,
    "created_at": "2024-03-05T12:00:00Z",
    "updated_at": "2024-03-05T12:00:00Z"
  },
  {
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "board_id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "In Progress",
    "position": 1,
    "wip_limit": 3,
    "created_at": "2024-03-05T12:00:00Z",
    "updated_at": "2024-03-05T12:00:00Z"
  }
]

Get a Column by ID

Retrieve a specific column:
kanban column get <ID>
id
uuid
required
The UUID of the column.

Example

kanban column get 6ba7b810-9dad-11d1-80b4-00c04fd430c8

Update a Column

Update column properties:
kanban column update <ID> [OPTIONS]
id
uuid
required
The UUID of the column to update.
--name
string
Update the column name.
--position
integer
Update the column position.
--wip-limit
integer
Set or update the WIP (Work In Progress) limit. This is the maximum number of cards allowed in this column.
--clear-wip-limit
flag
Remove the WIP limit from the column.

Examples

# Update column name and WIP limit
kanban column update 6ba7b810-9dad-11d1-80b4-00c04fd430c8 \
  --name "Work In Progress" \
  --wip-limit 5

# Remove WIP limit
kanban column update 6ba7b810-9dad-11d1-80b4-00c04fd430c8 --clear-wip-limit

# Change position
kanban column update 6ba7b810-9dad-11d1-80b4-00c04fd430c8 --position 2

Delete a Column

Permanently delete a column:
kanban column delete <ID>
id
uuid
required
The UUID of the column to delete.
Deleting a column will also affect all cards in that column. Make sure to move or archive cards before deleting.

Example

kanban column delete 6ba7b810-9dad-11d1-80b4-00c04fd430c8

Reorder a Column

Change the position of a column:
kanban column reorder <ID> --position <POSITION>
id
uuid
required
The UUID of the column to reorder.
--position
integer
required
The new position (0-indexed).

Example

# Move column to the first position
kanban column reorder 6ba7b810-9dad-11d1-80b4-00c04fd430c8 --position 0

WIP Limits

Work In Progress (WIP) limits help teams focus by restricting the number of cards in a column. When a column reaches its WIP limit, no more cards can be moved into it until some are moved out.

Setting a WIP Limit

kanban column update <COLUMN_ID> --wip-limit 3
This sets a maximum of 3 cards for the column.

Removing a WIP Limit

kanban column update <COLUMN_ID> --clear-wip-limit

Checking WIP Limit Status

# Get column details including current card count
kanban column get <COLUMN_ID>

# Count cards in column
kanban card list --column-id <COLUMN_ID> | jq 'length'

Common Workflows

Create a Standard Workflow

# Get board ID
BOARD_ID="550e8400-e29b-41d4-a716-446655440000"

# Create columns
kanban column create --board-id $BOARD_ID --name "Backlog" --position 0
kanban column create --board-id $BOARD_ID --name "Todo" --position 1
kanban column create --board-id $BOARD_ID --name "In Progress" --position 2
kanban column create --board-id $BOARD_ID --name "Review" --position 3
kanban column create --board-id $BOARD_ID --name "Done" --position 4

# Set WIP limit on "In Progress"
IN_PROGRESS_ID=$(kanban column list --board-id $BOARD_ID | jq -r '.[] | select(.name == "In Progress") | .id')
kanban column update $IN_PROGRESS_ID --wip-limit 3

Reorder All Columns

# List columns and manually reorder
kanban column list --board-id $BOARD_ID | jq -r '.[] | .id' | \
while read -r idx col_id; do
  kanban column reorder $col_id --position $idx
  idx=$((idx + 1))
done

View Column Statistics

# Get card count for each column
kanban column list --board-id $BOARD_ID | jq -r '.[] | .id' | \
while read col_id; do
  count=$(kanban card list --column-id $col_id | jq 'length')
  name=$(kanban column get $col_id | jq -r '.name')
  echo "$name: $count cards"
done

Build docs developers (and LLMs) love