Skip to content

Commit 6bf1a33

Browse files
committed
docs: add custom task ID documentation
1 parent 8df6765 commit 6bf1a33

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,23 @@ Environment variables override config file values:
307307

308308
When both are set, the config file is not required. Useful for CI/CD and containerized agents.
309309

310+
## Custom Task IDs
311+
312+
ClickUp workspaces can configure custom task IDs with a prefix per space (e.g., `PROJ-123`, `DEV-42`). The CLI detects these automatically - any ID matching the `PREFIX-DIGITS` format (uppercase letters, hyphen, digits) is treated as a custom task ID.
313+
314+
All commands that accept task IDs work with both native IDs and custom IDs:
315+
316+
```bash
317+
cu task PROJ-123
318+
cu update DEV-42 --status done
319+
cu comment PROJ-456 -m "Fixed in latest commit"
320+
cu subtasks DEV-100
321+
```
322+
323+
Custom ID resolution uses the `teamId` from your config, which is required (`cu init` sets it up).
324+
325+
**Task links with custom IDs:** The `cu link` command passes both task IDs in a single API request. When both IDs are custom, this works correctly. However, mixing custom and native IDs in a single link command may not work as expected because the ClickUp API applies the `custom_task_ids` flag to all IDs in the request.
326+
310327
## Why a CLI and not MCP?
311328

312329
A CLI + skill file has fewer moving parts. No server process, no protocol layer. The agent already knows how to run shell commands - the skill file teaches it which ones exist. For tool-use with coding agents, CLI + instructions tends to work better than MCP in practice.

skills/clickup-cli/SKILL.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ All commands support `--help` for full flag details.
9494

9595
| Topic | Detail |
9696
| ------------------------- | ------------------------------------------------------------------------------------------------------ |
97-
| Task IDs | Stable alphanumeric strings (e.g. `abc123def`) |
97+
| Task IDs | Native (`abc123def`) or custom (`PROJ-123`). Custom IDs auto-detected by `PREFIX-DIGITS` format |
9898
| `--type` | Filter by task type: `task` (regular), or custom type name/ID (e.g. `initiative`, `Bug`) |
9999
| `--list` on create | Optional when `--parent` is given (auto-detected) |
100100
| `--status` | Fuzzy matching: exact > starts-with > contains. Prints match to stderr. |
@@ -124,6 +124,8 @@ All commands support `--help` for full flag details.
124124
| `cu comment-edit` | Edit comment text and resolution status |
125125
| `cu comment-delete` | Delete a comment |
126126
| `cu replies` / `cu reply` | View and post threaded comment replies |
127+
| Custom task IDs | Auto-detected by format (`PROJ-123`). Uses `teamId` from config. All commands support them |
128+
| `cu link` + custom IDs | Both IDs must be the same type (both custom or both native). Mixing may not work |
127129
| `cu link` | Link/unlink tasks (different from dependencies) |
128130
| `cu attach` | Upload files to tasks. Attachments shown in `cu task` detail view |
129131
| `cu task` | Shows custom fields, checklists, and attachments in detail view |

0 commit comments

Comments
 (0)