diff --git a/test-list-commands.md b/test-list-commands.md deleted file mode 100644 index 8ba528f..0000000 --- a/test-list-commands.md +++ /dev/null @@ -1,95 +0,0 @@ -# Testing List Commands - -This document demonstrates how to use the new list management commands. - -## Prerequisites -1. Set up your Planka API credentials: - ```bash - export PLANKA_URL="https://your-planka-instance.com" - export PLANKA_API_KEY="your-api-key" - ``` - -2. Have a project and board available. You can create them with: - ```bash - ./pcli project create --name "Test Project" - ./pcli board create --project --name "Test Board" - ``` - -## List Management Commands - -### 1. Create a new list (column) -```bash -# Create an "To Do" list -./pcli list create --board --name "To Do" --type "active" - -# Create a "Done" list with specific position -./pcli list create --board --name "Done" --type "closed" --position 131072 -``` - -### 2. Get list details -```bash -./pcli list get -``` - -### 3. Update a list -```bash -# Change the name -./pcli list update --name "In Progress" - -# Change the color -./pcli list update --color "berry-red" - -# Move list to a different position -./pcli list update --position 98304 - -# Move list to a different board -./pcli list update --board -``` - -### 4. Delete a list -```bash -./pcli list delete -``` - -## Output Formats - -All commands support both JSON and table output formats: - -```bash -# JSON output (default) -./pcli list get - -# Table output -./pcli list get --format table -``` - -## Example Workflow - -```bash -# 1. List existing boards to get the board ID -./pcli board list --format table - -# 2. Create multiple lists for a Kanban board -./pcli list create --board --name "Backlog" --type "active" --position 0 -./pcli list create --board --name "To Do" --type "active" --position 65536 -./pcli list create --board --name "In Progress" --type "active" --position 131072 -./pcli list create --board --name "Done" --type "closed" --position 196608 - -# 3. View the board with its lists -./pcli board get --format table - -# 4. Update a list color -./pcli list update --color "lagoon-blue" - -# 5. Clean up (optional) -./pcli list delete -``` - -## Notes - -- List types can be "active" or "closed" -- Active lists are for ongoing work -- Closed lists are for completed/archived items -- Position determines the order of lists on the board (lower numbers appear first) -- Colors must be one of the supported Planka list colors -- Deleting a list moves its cards to a trash list (doesn't permanently delete cards)