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
Board commands allow you to create and manage kanban boards. Each board contains columns, cards, and optionally sprints.
Commands
Create a Board
Create a new kanban board:
kanban board create --name <NAME> [--card-prefix <PREFIX>]
Optional prefix for card IDs (e.g., “PROJ” generates cards like “PROJ-1”, “PROJ-2”).
Example
kanban board create --name "My Project" --card-prefix "PROJ"
Output
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "My Project",
"card_prefix": "PROJ",
"description": null,
"sprint_prefix": null,
"created_at": "2024-03-05T12:00:00Z",
"updated_at": "2024-03-05T12:00:00Z"
}
List All Boards
List all boards in the kanban data file:
Example Output
[
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "My Project",
"card_prefix": "PROJ",
"description": null,
"sprint_prefix": null,
"created_at": "2024-03-05T12:00:00Z",
"updated_at": "2024-03-05T12:00:00Z"
}
]
Get a Board by ID
Retrieve a specific board by its UUID:
Example
kanban board get 550e8400-e29b-41d4-a716-446655440000
Update a Board
Update board properties:
kanban board update <ID> [OPTIONS]
The UUID of the board to update.
Update the board description.
Set the prefix for sprint IDs (e.g., “S” generates sprints like “S-1”, “S-2”).
Update the prefix for card IDs.
Example
kanban board update 550e8400-e29b-41d4-a716-446655440000 \
--name "Updated Project" \
--description "My project description" \
--sprint-prefix "SP"
Delete a Board
Permanently delete a board and all its data:
The UUID of the board to delete.
This action is irreversible and will delete all columns, cards, and sprints associated with the board.
Example
kanban board delete 550e8400-e29b-41d4-a716-446655440000
Common Workflows
Initialize a New Project
# Create board
BOARD_ID=$(kanban board create --name "My Project" --card-prefix "PROJ" | jq -r '.id')
# Create default 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
List All Board Details
# Get all boards with formatted output
kanban board list | jq '.[] | "\(.name) (\(.id))"'
