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

Card commands provide comprehensive card management including creation, updates, movement between columns, archiving, sprint assignment, and git integration.

Commands

Create a Card

Create a new card in a column:
kanban card create --board-id <BOARD_ID> --column-id <COLUMN_ID> --title <TITLE> [OPTIONS]
--board-id
uuid
required
The UUID of the board.
--column-id
uuid
required
The UUID of the column where the card will be created.
--title
string
required
The title of the card.
--description
string
Optional description for the card.
--priority
string
Priority level (e.g., “low”, “medium”, “high”).
--points
integer
Story points (0-255).
--due-date
string
Due date in ISO 8601 format (e.g., “2024-12-31”).

Example

kanban card create \
  --board-id 550e8400-e29b-41d4-a716-446655440000 \
  --column-id 6ba7b810-9dad-11d1-80b4-00c04fd430c8 \
  --title "Implement user authentication" \
  --description "Add JWT-based authentication" \
  --priority "high" \
  --points 8 \
  --due-date "2024-03-15"

List Cards

List cards with optional filters:
kanban card list [OPTIONS]
--board-id
uuid
Filter by board ID.
--column-id
uuid
Filter by column ID.
--sprint-id
uuid
Filter by sprint ID.
--status
string
Filter by status.
--archived
flag
Include archived cards.

Examples

# List all cards in a board
kanban card list --board-id 550e8400-e29b-41d4-a716-446655440000

# List cards in a specific column
kanban card list --column-id 6ba7b810-9dad-11d1-80b4-00c04fd430c8

# List cards in a sprint
kanban card list --sprint-id 7c9e6679-7425-40de-944b-e07fc1f90ae7

# List archived cards
kanban card list --board-id 550e8400-e29b-41d4-a716-446655440000 --archived

Get a Card by ID

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

Update a Card

Update card properties:
kanban card update <ID> [OPTIONS]
id
uuid
required
The UUID of the card to update.
--title
string
Update the card title.
--description
string
Update the card description.
--priority
string
Update the priority.
--status
string
Update the status.
--points
integer
Update story points.
--due-date
string
Update due date.
--clear-due-date
flag
Remove the due date.

Example

kanban card update 550e8400-e29b-41d4-a716-446655440000 \
  --title "Updated title" \
  --priority "critical" \
  --points 13

Move a Card

Move a card to another column:
kanban card move <ID> --column-id <COLUMN_ID> [--position <POSITION>]
id
uuid
required
The UUID of the card to move.
--column-id
uuid
required
The UUID of the destination column.
--position
integer
Optional position in the column (0-indexed).

Example

kanban card move 550e8400-e29b-41d4-a716-446655440000 \
  --column-id 6ba7b810-9dad-11d1-80b4-00c04fd430c8 \
  --position 0

Archive a Card

Archive a card (soft delete):
kanban card archive <ID>
id
uuid
required
The UUID of the card to archive.

Example

kanban card archive 550e8400-e29b-41d4-a716-446655440000

Restore an Archived Card

Restore a previously archived card:
kanban card restore <ID> [--column-id <COLUMN_ID>]
id
uuid
required
The UUID of the card to restore.
--column-id
uuid
Optional column ID to restore the card to. If not specified, restores to the original column.

Example

kanban card restore 550e8400-e29b-41d4-a716-446655440000 \
  --column-id 6ba7b810-9dad-11d1-80b4-00c04fd430c8

Delete a Card

Permanently delete an archived card:
kanban card delete <ID>
id
uuid
required
The UUID of the archived card to delete.
This action is irreversible. Only archived cards can be deleted.

Sprint Management

Assign Card to Sprint

Assign a card to a sprint:
kanban card assign-sprint <ID> --sprint-id <SPRINT_ID>
id
uuid
required
The UUID of the card.
--sprint-id
uuid
required
The UUID of the sprint.

Example

kanban card assign-sprint 550e8400-e29b-41d4-a716-446655440000 \
  --sprint-id 7c9e6679-7425-40de-944b-e07fc1f90ae7

Unassign Card from Sprint

Remove a card from its sprint:
kanban card unassign-sprint <ID>
id
uuid
required
The UUID of the card.

Git Integration

Get Branch Name

Generate a git branch name for a card:
kanban card branch-name <ID>
id
uuid
required
The UUID of the card.

Example

kanban card branch-name 550e8400-e29b-41d4-a716-446655440000
# Output: "PROJ-123-implement-user-authentication"

Get Git Checkout Command

Generate a git checkout command for a card:
kanban card git-checkout <ID>
id
uuid
required
The UUID of the card.

Example

# Get the checkout command
CHECKOUT_CMD=$(kanban card git-checkout 550e8400-e29b-41d4-a716-446655440000)

# Execute it
eval $CHECKOUT_CMD

Bulk Operations

Bulk Archive Cards

Archive multiple cards at once:
kanban card bulk-archive --ids <ID1>,<ID2>,<ID3>
--ids
uuid[]
required
Comma-separated list of card UUIDs.

Example

kanban card bulk-archive --ids \
  550e8400-e29b-41d4-a716-446655440000,\
  6ba7b810-9dad-11d1-80b4-00c04fd430c8,\
  7c9e6679-7425-40de-944b-e07fc1f90ae7

Bulk Move Cards

Move multiple cards to a column:
kanban card bulk-move --ids <ID1>,<ID2> --column-id <COLUMN_ID>
--ids
uuid[]
required
Comma-separated list of card UUIDs.
--column-id
uuid
required
The UUID of the destination column.

Example

kanban card bulk-move \
  --ids 550e8400-e29b-41d4-a716-446655440000,6ba7b810-9dad-11d1-80b4-00c04fd430c8 \
  --column-id 7c9e6679-7425-40de-944b-e07fc1f90ae7

Bulk Assign Cards to Sprint

Assign multiple cards to a sprint:
kanban card bulk-assign-sprint --ids <ID1>,<ID2> --sprint-id <SPRINT_ID>
--ids
uuid[]
required
Comma-separated list of card UUIDs.
--sprint-id
uuid
required
The UUID of the sprint.

Example

kanban card bulk-assign-sprint \
  --ids 550e8400-e29b-41d4-a716-446655440000,6ba7b810-9dad-11d1-80b4-00c04fd430c8 \
  --sprint-id 7c9e6679-7425-40de-944b-e07fc1f90ae7

Common Workflows

Create and Start Working on a Card

# Create card
CARD_ID=$(kanban card create \
  --board-id $BOARD_ID \
  --column-id $TODO_COLUMN_ID \
  --title "Implement feature" \
  --priority "high" | jq -r '.id')

# Move to "In Progress" column
kanban card move $CARD_ID --column-id $IN_PROGRESS_COLUMN_ID

# Create and checkout git branch
eval $(kanban card git-checkout $CARD_ID)

Sprint Planning

# Get all backlog cards
BACKLOG_CARDS=$(kanban card list --column-id $BACKLOG_COLUMN_ID | jq -r '.[].id')

# Assign high priority cards to sprint
for card_id in $(echo $BACKLOG_CARDS | jq -r '.[] | select(.priority == "high") | .id'); do
  kanban card assign-sprint $card_id --sprint-id $SPRINT_ID
done

Build docs developers (and LLMs) love