@krodak/clickup-cli 0.13.2 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +160 -441
- package/dist/index.js +553 -4
- package/package.json +1 -1
- package/skills/clickup-cli/SKILL.md +27 -2
package/README.md
CHANGED
|
@@ -8,503 +8,218 @@
|
|
|
8
8
|
[](https://github.com/krodak/clickup-cli/actions/workflows/ci.yml)
|
|
9
9
|
|
|
10
10
|
```bash
|
|
11
|
-
npm install -g @krodak/clickup-cli
|
|
12
|
-
cu init # walks you through API token + workspace setup
|
|
11
|
+
npm install -g @krodak/clickup-cli && cu init
|
|
13
12
|
```
|
|
14
13
|
|
|
15
|
-
|
|
14
|
+
## Talk to your agent
|
|
16
15
|
|
|
17
|
-
|
|
16
|
+
Install `cu`, install the skill file, and your agent works with ClickUp. No API knowledge needed.
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
> **"Read task abc123, do the work, then mark it in review and leave a comment with the commit hash."**
|
|
20
19
|
|
|
21
|
-
|
|
20
|
+
> **"What's my standup? What did I finish, what's in progress, what's overdue?"**
|
|
22
21
|
|
|
23
|
-
|
|
22
|
+
> **"Create a subtask under the initiative for the edge case we found."**
|
|
24
23
|
|
|
25
|
-
**
|
|
24
|
+
> **"Check my sprint and tell me what's behind schedule."**
|
|
26
25
|
|
|
27
|
-
|
|
26
|
+
> **"Update the description with your findings and flag blockers in a comment."**
|
|
28
27
|
|
|
29
|
-
|
|
30
|
-
claude --plugin-dir ./node_modules/@krodak/clickup-cli
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
Or copy the skill manually:
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
mkdir -p ~/.claude/skills/clickup
|
|
37
|
-
cp skills/clickup-cli/SKILL.md ~/.claude/skills/clickup/SKILL.md
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
Then reference it in your `CLAUDE.md` or project instructions.
|
|
41
|
-
|
|
42
|
-
**OpenCode:**
|
|
43
|
-
|
|
44
|
-
```bash
|
|
45
|
-
mkdir -p ~/.config/opencode/skills/clickup
|
|
46
|
-
cp skills/clickup-cli/SKILL.md ~/.config/opencode/skills/clickup/SKILL.md
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
**Codex / other agents:**
|
|
50
|
-
|
|
51
|
-
Copy the contents of `skills/clickup-cli/SKILL.md` into your system prompt or project instructions. It's a standalone markdown document.
|
|
52
|
-
|
|
53
|
-
### 2. Talk to your agent
|
|
54
|
-
|
|
55
|
-
Once the skill is installed, you just tell the agent what you need in plain language. It figures out which `cu` commands to run.
|
|
56
|
-
|
|
57
|
-
```
|
|
58
|
-
"Read the description of task <id>, do the work, then mark it in review and leave a comment with the commit hash."
|
|
28
|
+
The agent reads the skill file, picks the right `cu` commands, and handles everything. You don't need to learn the CLI - the agent does.
|
|
59
29
|
|
|
60
|
-
|
|
30
|
+
## Setup
|
|
61
31
|
|
|
62
|
-
|
|
32
|
+
You need Node 22+ and a ClickUp personal API token (`pk_...` from [ClickUp Settings > Apps](https://app.clickup.com/settings/apps)).
|
|
63
33
|
|
|
64
|
-
|
|
34
|
+
<details open>
|
|
35
|
+
<summary> <img src="https://cdn.simpleicons.org/openai/999999" height="16" align="center"> <strong>OpenCode</strong></summary>
|
|
65
36
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
"Check my sprint and tell me what's overdue."
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
You don't need to learn the CLI commands yourself. The agent handles it.
|
|
72
|
-
|
|
73
|
-
### Why a CLI and not MCP?
|
|
74
|
-
|
|
75
|
-
A CLI + skill file has fewer moving parts. No extra server process, no protocol layer. The agent already knows how to run shell commands - the skill file just teaches it which ones exist. This matches what Peter Steinberger and the OpenClaw project have found: for tool-use with coding agents, CLI + instructions tends to work better than MCP in practice.
|
|
76
|
-
|
|
77
|
-
### Scoped output
|
|
78
|
-
|
|
79
|
-
Most commands return only your tasks by default. `cu tasks`, `cu sprint`, `cu overdue`, `cu summary` all scope to what's assigned to you. `cu spaces --my` filters to spaces where you have tasks. This keeps output small and relevant - important when it's going into an agent's context window.
|
|
80
|
-
|
|
81
|
-
## Using from the terminal
|
|
82
|
-
|
|
83
|
-
When you run `cu` in a terminal directly, you get an interactive mode with tables and a task picker.
|
|
84
|
-
|
|
85
|
-
```bash
|
|
86
|
-
cu tasks # interactive table with checkbox picker
|
|
87
|
-
cu sprint # your sprint tasks, auto-detected
|
|
88
|
-
cu summary # standup helper: completed / in progress / overdue
|
|
89
|
-
cu overdue # tasks past their due date
|
|
90
|
-
cu open "login bug" # fuzzy search, opens in browser
|
|
91
|
-
cu update abc123 -s "done" # update status
|
|
92
|
-
cu assign abc123 --to me # assign yourself
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
Pass `--json` to any read command to force JSON output instead of the default format.
|
|
96
|
-
|
|
97
|
-
When output is piped (no TTY), all commands output **Markdown** by default - optimized for AI agent context windows. Pass `--json` to any command for JSON output. Set `CU_OUTPUT=json` environment variable to always get JSON when piped.
|
|
98
|
-
|
|
99
|
-
## Commands
|
|
100
|
-
|
|
101
|
-
29 commands total. All support `--help` for full flag details.
|
|
102
|
-
|
|
103
|
-
### `cu init`
|
|
104
|
-
|
|
105
|
-
First-time setup. Prompts for your API token, verifies it, auto-detects your workspace, and writes `~/.config/cu/config.json`.
|
|
37
|
+
**1. Install the CLI**
|
|
106
38
|
|
|
107
39
|
```bash
|
|
40
|
+
npm install -g @krodak/clickup-cli
|
|
108
41
|
cu init
|
|
109
42
|
```
|
|
110
43
|
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
List tasks assigned to me. By default shows all task types. Use `--type` to filter by task type.
|
|
114
|
-
|
|
115
|
-
```bash
|
|
116
|
-
cu tasks
|
|
117
|
-
cu tasks --status "in progress"
|
|
118
|
-
cu tasks --name "login"
|
|
119
|
-
cu tasks --type task # regular tasks only
|
|
120
|
-
cu tasks --type initiative # initiatives only
|
|
121
|
-
cu tasks --type "Bug" # custom task type by name
|
|
122
|
-
cu tasks --list <listId>
|
|
123
|
-
cu tasks --space <spaceId>
|
|
124
|
-
cu tasks --include-closed
|
|
125
|
-
cu tasks --json
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
### `cu sprint`
|
|
129
|
-
|
|
130
|
-
List my tasks in the currently active sprint (auto-detected from sprint folder date ranges).
|
|
131
|
-
|
|
132
|
-
```bash
|
|
133
|
-
cu sprint
|
|
134
|
-
cu sprint --status "in progress"
|
|
135
|
-
cu sprint --include-closed
|
|
136
|
-
cu sprint --json
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
### `cu sprints`
|
|
140
|
-
|
|
141
|
-
List all sprints across sprint folders. Marks the currently active sprint.
|
|
142
|
-
|
|
143
|
-
```bash
|
|
144
|
-
cu sprints
|
|
145
|
-
cu sprints --space "Engineering"
|
|
146
|
-
cu sprints --json
|
|
147
|
-
```
|
|
148
|
-
|
|
149
|
-
### `cu assigned`
|
|
150
|
-
|
|
151
|
-
All tasks assigned to me, grouped by pipeline stage (code review, in progress, to do, etc.).
|
|
152
|
-
|
|
153
|
-
```bash
|
|
154
|
-
cu assigned
|
|
155
|
-
cu assigned --status "in progress"
|
|
156
|
-
cu assigned --include-closed
|
|
157
|
-
cu assigned --json
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
### `cu inbox`
|
|
161
|
-
|
|
162
|
-
Tasks assigned to me that were recently updated, grouped by time period (today, yesterday, last 7 days, etc.). Default lookback is 30 days.
|
|
163
|
-
|
|
164
|
-
```bash
|
|
165
|
-
cu inbox
|
|
166
|
-
cu inbox --days 7
|
|
167
|
-
cu inbox --include-closed
|
|
168
|
-
cu inbox --json
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
### `cu task <id>`
|
|
172
|
-
|
|
173
|
-
Get task details including custom fields. Pretty summary in terminal, JSON when piped.
|
|
174
|
-
|
|
175
|
-
```bash
|
|
176
|
-
cu task abc123
|
|
177
|
-
cu task abc123 --json
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
**Note:** When piped, `cu task` outputs a structured Markdown summary of the task. For the full raw API response with all fields (custom fields, checklists, etc.), use `--json`.
|
|
181
|
-
|
|
182
|
-
### `cu subtasks <id>`
|
|
183
|
-
|
|
184
|
-
List subtasks of a task.
|
|
185
|
-
|
|
186
|
-
```bash
|
|
187
|
-
cu subtasks abc123
|
|
188
|
-
cu subtasks abc123 --status "in progress"
|
|
189
|
-
cu subtasks abc123 --name "auth"
|
|
190
|
-
cu subtasks abc123 --include-closed
|
|
191
|
-
cu subtasks abc123 --json
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
### `cu update <id>`
|
|
195
|
-
|
|
196
|
-
Update a task. Provide at least one option.
|
|
197
|
-
|
|
198
|
-
```bash
|
|
199
|
-
cu update abc123 -s "in progress"
|
|
200
|
-
cu update abc123 -n "New task name"
|
|
201
|
-
cu update abc123 -d "Updated description with **markdown**"
|
|
202
|
-
cu update abc123 --priority high
|
|
203
|
-
cu update abc123 --due-date 2025-03-15
|
|
204
|
-
cu update abc123 --assignee me
|
|
205
|
-
cu update abc123 --assignee 12345
|
|
206
|
-
cu update abc123 -n "New name" -s "done" --priority urgent
|
|
207
|
-
cu update abc123 --time-estimate 2h
|
|
208
|
-
cu update abc123 --parent parentTaskId # make it a subtask
|
|
209
|
-
cu update abc123 -s "in progress" --json
|
|
210
|
-
```
|
|
211
|
-
|
|
212
|
-
| Flag | Description |
|
|
213
|
-
| ---------------------------- | --------------------------------------------------------------------------- |
|
|
214
|
-
| `-n, --name <text>` | New task name |
|
|
215
|
-
| `-d, --description <text>` | New description (markdown supported) |
|
|
216
|
-
| `-s, --status <status>` | New status, supports fuzzy matching (e.g. `"prog"` matches `"in progress"`) |
|
|
217
|
-
| `--priority <level>` | Priority: `urgent`, `high`, `normal`, `low` (or 1-4) |
|
|
218
|
-
| `--due-date <date>` | Due date (`YYYY-MM-DD`) |
|
|
219
|
-
| `--time-estimate <duration>` | Time estimate (e.g. `"2h"`, `"30m"`, `"1h30m"`) |
|
|
220
|
-
| `--assignee <userId>` | Add assignee by user ID or `"me"` |
|
|
221
|
-
| `--parent <taskId>` | Set parent task (makes this a subtask) |
|
|
222
|
-
| `--json` | Force JSON output even in terminal |
|
|
223
|
-
|
|
224
|
-
### `cu create`
|
|
225
|
-
|
|
226
|
-
Create a new task. If `--parent` is given, list is auto-detected from the parent task.
|
|
227
|
-
|
|
228
|
-
```bash
|
|
229
|
-
cu create -n "Fix login bug" -l <listId>
|
|
230
|
-
cu create -n "Subtask name" -p <parentTaskId> # --list auto-detected
|
|
231
|
-
cu create -n "Task" -l <listId> -d "desc" -s "open"
|
|
232
|
-
cu create -n "Task" -l <listId> --priority high --due-date 2025-06-01
|
|
233
|
-
cu create -n "Task" -l <listId> --assignee me --tags "bug,frontend"
|
|
234
|
-
cu create -n "Initiative" -l <listId> --custom-item-id 1
|
|
235
|
-
cu create -n "Task" -l <listId> --time-estimate 2h
|
|
236
|
-
cu create -n "Fix bug" -l <listId> --json
|
|
237
|
-
```
|
|
238
|
-
|
|
239
|
-
| Flag | Required | Description |
|
|
240
|
-
| ---------------------------- | ---------------- | ---------------------------------------------------- |
|
|
241
|
-
| `-n, --name <name>` | yes | Task name |
|
|
242
|
-
| `-l, --list <listId>` | if no `--parent` | Target list ID |
|
|
243
|
-
| `-p, --parent <taskId>` | no | Parent task (list auto-detected) |
|
|
244
|
-
| `-d, --description <text>` | no | Description (markdown) |
|
|
245
|
-
| `-s, --status <status>` | no | Initial status |
|
|
246
|
-
| `--priority <level>` | no | Priority: `urgent`, `high`, `normal`, `low` (or 1-4) |
|
|
247
|
-
| `--due-date <date>` | no | Due date (`YYYY-MM-DD`) |
|
|
248
|
-
| `--time-estimate <duration>` | no | Time estimate (e.g. `"2h"`, `"30m"`, `"1h30m"`) |
|
|
249
|
-
| `--assignee <userId>` | no | Assignee by user ID or `"me"` |
|
|
250
|
-
| `--tags <tags>` | no | Comma-separated tag names |
|
|
251
|
-
| `--custom-item-id <id>` | no | Custom task type ID (e.g. for creating initiatives) |
|
|
252
|
-
| `--json` | no | Force JSON output even in terminal |
|
|
253
|
-
|
|
254
|
-
### `cu delete <id>`
|
|
255
|
-
|
|
256
|
-
Delete a task. **DESTRUCTIVE - cannot be undone.**
|
|
257
|
-
|
|
258
|
-
```bash
|
|
259
|
-
cu delete abc123
|
|
260
|
-
cu delete abc123 --confirm
|
|
261
|
-
cu delete abc123 --confirm --json
|
|
262
|
-
```
|
|
263
|
-
|
|
264
|
-
In TTY mode without `--confirm`: shows the task name and prompts for confirmation (default: No). In non-interactive/piped mode, `--confirm` is required.
|
|
265
|
-
|
|
266
|
-
| Flag | Description |
|
|
267
|
-
| ----------- | ----------------------------------------------------------- |
|
|
268
|
-
| `--confirm` | Skip confirmation prompt (required in non-interactive mode) |
|
|
269
|
-
| `--json` | Force JSON output |
|
|
270
|
-
|
|
271
|
-
### `cu field <id>`
|
|
272
|
-
|
|
273
|
-
Set or remove a custom field value. Field names are resolved case-insensitively; errors list available fields/options.
|
|
274
|
-
|
|
275
|
-
```bash
|
|
276
|
-
cu field abc123 --set "Priority Level" high
|
|
277
|
-
cu field abc123 --set "Story Points" 5
|
|
278
|
-
cu field abc123 --set "Approved" true
|
|
279
|
-
cu field abc123 --set "Category" "Bug Fix"
|
|
280
|
-
cu field abc123 --set "Due" 2025-06-01
|
|
281
|
-
cu field abc123 --set "Website" "https://example.com"
|
|
282
|
-
cu field abc123 --set "Contact" "user@example.com"
|
|
283
|
-
cu field abc123 --remove "Priority Level"
|
|
284
|
-
cu field abc123 --set "Points" 3 --remove "Old Field"
|
|
285
|
-
cu field abc123 --set "Points" 3 --json
|
|
286
|
-
```
|
|
287
|
-
|
|
288
|
-
| Flag | Description |
|
|
289
|
-
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
290
|
-
| `--set "Field Name" <val>` | Set a custom field by name. Supports: text, number, checkbox (true/false), dropdown (option name), date (YYYY-MM-DD), url, email |
|
|
291
|
-
| `--remove "Field Name"` | Remove a custom field value |
|
|
292
|
-
| `--json` | Force JSON output |
|
|
293
|
-
|
|
294
|
-
Both `--set` and `--remove` can be used together in one invocation.
|
|
295
|
-
|
|
296
|
-
### `cu comment <id>`
|
|
297
|
-
|
|
298
|
-
Post a comment on a task.
|
|
299
|
-
|
|
300
|
-
```bash
|
|
301
|
-
cu comment abc123 -m "Addressed in PR #42"
|
|
302
|
-
cu comment abc123 -m "Done" --json
|
|
303
|
-
```
|
|
304
|
-
|
|
305
|
-
### `cu comments <id>`
|
|
306
|
-
|
|
307
|
-
List comments on a task. Formatted view in terminal, JSON when piped.
|
|
308
|
-
|
|
309
|
-
```bash
|
|
310
|
-
cu comments abc123
|
|
311
|
-
cu comments abc123 --json
|
|
312
|
-
```
|
|
313
|
-
|
|
314
|
-
### `cu activity <id>`
|
|
315
|
-
|
|
316
|
-
View task details and comment history together. Combines `cu task` and `cu comments` into a single view.
|
|
317
|
-
|
|
318
|
-
```bash
|
|
319
|
-
cu activity abc123
|
|
320
|
-
cu activity abc123 --json
|
|
321
|
-
```
|
|
322
|
-
|
|
323
|
-
### `cu lists <spaceId>`
|
|
324
|
-
|
|
325
|
-
List all lists in a space, including lists inside folders. Useful for discovering list IDs needed by `--list` filter and `cu create -l`.
|
|
326
|
-
|
|
327
|
-
```bash
|
|
328
|
-
cu lists <spaceId>
|
|
329
|
-
cu lists <spaceId> --name "sprint"
|
|
330
|
-
cu lists <spaceId> --json
|
|
331
|
-
```
|
|
332
|
-
|
|
333
|
-
| Flag | Description |
|
|
334
|
-
| ------------------ | ---------------------------------- |
|
|
335
|
-
| `--name <partial>` | Filter lists by partial name match |
|
|
336
|
-
| `--json` | Force JSON output |
|
|
337
|
-
|
|
338
|
-
### `cu spaces`
|
|
339
|
-
|
|
340
|
-
List spaces in your workspace. Useful for getting space IDs for the `--space` filter.
|
|
341
|
-
|
|
342
|
-
```bash
|
|
343
|
-
cu spaces
|
|
344
|
-
cu spaces --name "eng"
|
|
345
|
-
cu spaces --my
|
|
346
|
-
cu spaces --json
|
|
347
|
-
```
|
|
348
|
-
|
|
349
|
-
| Flag | Description |
|
|
350
|
-
| ------------------ | -------------------------------------------- |
|
|
351
|
-
| `--name <partial>` | Filter spaces by partial name match |
|
|
352
|
-
| `--my` | Show only spaces where I have assigned tasks |
|
|
353
|
-
| `--json` | Force JSON output |
|
|
354
|
-
|
|
355
|
-
### `cu open <query>`
|
|
356
|
-
|
|
357
|
-
Open a task in the browser. Accepts a task ID or partial name.
|
|
358
|
-
|
|
359
|
-
```bash
|
|
360
|
-
cu open abc123
|
|
361
|
-
cu open "login bug"
|
|
362
|
-
cu open abc123 --json
|
|
363
|
-
```
|
|
364
|
-
|
|
365
|
-
If the query matches multiple tasks by name, all matches are listed and the first is opened.
|
|
366
|
-
|
|
367
|
-
### `cu search <query>`
|
|
368
|
-
|
|
369
|
-
Search my tasks by name. Supports multi-word queries with case-insensitive matching. Status filter supports fuzzy matching.
|
|
370
|
-
|
|
371
|
-
```bash
|
|
372
|
-
cu search "login bug"
|
|
373
|
-
cu search auth
|
|
374
|
-
cu search "payment flow" --json
|
|
375
|
-
cu search auth --status "prog" # fuzzy matches "in progress"
|
|
376
|
-
cu search "old task" --include-closed
|
|
377
|
-
```
|
|
378
|
-
|
|
379
|
-
### `cu summary`
|
|
380
|
-
|
|
381
|
-
Daily standup helper. Shows tasks grouped into: recently completed, in progress, and overdue.
|
|
44
|
+
**2. Install the skill**
|
|
382
45
|
|
|
383
46
|
```bash
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
cu summary --json
|
|
47
|
+
mkdir -p ~/.config/opencode/skills/clickup
|
|
48
|
+
cp $(npm root -g)/@krodak/clickup-cli/skills/clickup-cli/SKILL.md ~/.config/opencode/skills/clickup/SKILL.md
|
|
387
49
|
```
|
|
388
50
|
|
|
389
|
-
|
|
390
|
-
| ------------- | -------------------------------------------------- |
|
|
391
|
-
| `--hours <n>` | Lookback for recently completed tasks (default 24) |
|
|
392
|
-
| `--json` | Force JSON output |
|
|
51
|
+
</details>
|
|
393
52
|
|
|
394
|
-
|
|
53
|
+
<details>
|
|
54
|
+
<summary> <img src="https://cdn.simpleicons.org/anthropic/D97757" height="16" align="center"> <strong>Claude Code</strong></summary>
|
|
395
55
|
|
|
396
|
-
|
|
56
|
+
**1. Install the CLI**
|
|
397
57
|
|
|
398
58
|
```bash
|
|
399
|
-
|
|
400
|
-
cu
|
|
401
|
-
cu overdue --json
|
|
59
|
+
npm install -g @krodak/clickup-cli
|
|
60
|
+
cu init
|
|
402
61
|
```
|
|
403
62
|
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
Assign or unassign users from a task. Supports `me` as shorthand for your user ID.
|
|
63
|
+
**2. Install the skill**
|
|
407
64
|
|
|
408
65
|
```bash
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
cu assign abc123 --remove 12345
|
|
412
|
-
cu assign abc123 --to me --remove 67890
|
|
413
|
-
cu assign abc123 --to me --json
|
|
66
|
+
mkdir -p ~/.claude/skills/clickup
|
|
67
|
+
cp $(npm root -g)/@krodak/clickup-cli/skills/clickup-cli/SKILL.md ~/.claude/skills/clickup/SKILL.md
|
|
414
68
|
```
|
|
415
69
|
|
|
416
|
-
|
|
417
|
-
| ------------------- | --------------------------------- |
|
|
418
|
-
| `--to <userId>` | Add assignee (user ID or `me`) |
|
|
419
|
-
| `--remove <userId>` | Remove assignee (user ID or `me`) |
|
|
420
|
-
| `--json` | Force JSON output |
|
|
421
|
-
|
|
422
|
-
### `cu depend <id>`
|
|
423
|
-
|
|
424
|
-
Add or remove task dependencies. Set a task as waiting on or blocking another task.
|
|
70
|
+
Then reference it in your `CLAUDE.md` or project instructions.
|
|
425
71
|
|
|
426
|
-
|
|
427
|
-
cu depend abc123 --on def456 # abc123 depends on (waits for) def456
|
|
428
|
-
cu depend abc123 --blocks def456 # abc123 blocks def456
|
|
429
|
-
cu depend abc123 --on def456 --remove # remove the dependency
|
|
430
|
-
cu depend abc123 --blocks def456 --remove
|
|
431
|
-
cu depend abc123 --on def456 --json
|
|
432
|
-
```
|
|
72
|
+
</details>
|
|
433
73
|
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
| `--on <taskId>` | Task that this task depends on (waiting on) |
|
|
437
|
-
| `--blocks <taskId>` | Task that this task blocks |
|
|
438
|
-
| `--remove` | Remove the dependency instead of adding it |
|
|
439
|
-
| `--json` | Force JSON output |
|
|
74
|
+
<details>
|
|
75
|
+
<summary> <img src="https://cdn.simpleicons.org/anthropic/D97757" height="16" align="center"> <strong>Claude Desktop</strong></summary>
|
|
440
76
|
|
|
441
|
-
|
|
77
|
+
Claude Desktop doesn't run CLI tools directly. Use it alongside a coding agent (Claude Code, OpenCode) that has `cu` installed, or run `cu` commands manually in your terminal.
|
|
442
78
|
|
|
443
|
-
|
|
79
|
+
**Install the CLI:**
|
|
444
80
|
|
|
445
81
|
```bash
|
|
446
|
-
|
|
447
|
-
cu
|
|
448
|
-
cu move abc123 --to <newListId> --remove <oldListId> # move between lists
|
|
449
|
-
cu move abc123 --to <listId> --json
|
|
82
|
+
npm install -g @krodak/clickup-cli
|
|
83
|
+
cu init
|
|
450
84
|
```
|
|
451
85
|
|
|
452
|
-
|
|
453
|
-
| ------------------- | -------------------------- |
|
|
454
|
-
| `--to <listId>` | Add task to this list |
|
|
455
|
-
| `--remove <listId>` | Remove task from this list |
|
|
456
|
-
| `--json` | Force JSON output |
|
|
86
|
+
</details>
|
|
457
87
|
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
Add or remove tags on a task. Both `--add` and `--remove` can be used together.
|
|
88
|
+
<details>
|
|
89
|
+
<summary> <img src="https://cdn.simpleicons.org/homebrew/FBB040" height="16" align="center"> <strong>Homebrew</strong></summary>
|
|
461
90
|
|
|
462
91
|
```bash
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
cu
|
|
466
|
-
cu tag abc123 --add "bug" --remove "triage"
|
|
467
|
-
cu tag abc123 --add "bug" --json
|
|
92
|
+
brew tap krodak/tap
|
|
93
|
+
brew install clickup-cli
|
|
94
|
+
cu init
|
|
468
95
|
```
|
|
469
96
|
|
|
470
|
-
|
|
471
|
-
| ----------------- | ----------------------------------- |
|
|
472
|
-
| `--add <tags>` | Comma-separated tag names to add |
|
|
473
|
-
| `--remove <tags>` | Comma-separated tag names to remove |
|
|
474
|
-
| `--json` | Force JSON output |
|
|
97
|
+
Then install the skill for your agent (see OpenCode or Claude Code sections above).
|
|
475
98
|
|
|
476
|
-
|
|
99
|
+
</details>
|
|
477
100
|
|
|
478
|
-
|
|
101
|
+
<details>
|
|
102
|
+
<summary> <img src="https://cdn.simpleicons.org/openai/999999" height="16" align="center"> <strong>Codex / Other agents</strong></summary>
|
|
479
103
|
|
|
480
|
-
|
|
481
|
-
cu auth
|
|
482
|
-
cu auth --json
|
|
483
|
-
```
|
|
484
|
-
|
|
485
|
-
### `cu config`
|
|
486
|
-
|
|
487
|
-
Manage CLI configuration.
|
|
104
|
+
**1. Install the CLI**
|
|
488
105
|
|
|
489
106
|
```bash
|
|
490
|
-
|
|
491
|
-
cu
|
|
492
|
-
cu config path
|
|
107
|
+
npm install -g @krodak/clickup-cli
|
|
108
|
+
cu init
|
|
493
109
|
```
|
|
494
110
|
|
|
495
|
-
|
|
111
|
+
**2. Add the skill to your agent**
|
|
496
112
|
|
|
497
|
-
|
|
113
|
+
Copy `skills/clickup-cli/SKILL.md` into your agent's system prompt or project instructions. It's a standalone markdown document that teaches the agent all available commands.
|
|
498
114
|
|
|
499
|
-
|
|
115
|
+
</details>
|
|
500
116
|
|
|
501
|
-
|
|
502
|
-
eval "$(cu completion bash)" # Bash
|
|
503
|
-
eval "$(cu completion zsh)" # Zsh
|
|
504
|
-
cu completion fish > ~/.config/fish/completions/cu.fish # Fish
|
|
505
|
-
```
|
|
117
|
+
## Commands
|
|
506
118
|
|
|
507
|
-
|
|
119
|
+
36 commands total. [Full reference with examples and flags](docs/commands.md).
|
|
120
|
+
|
|
121
|
+
### Tasks
|
|
122
|
+
|
|
123
|
+
| Command | Description |
|
|
124
|
+
| --------------------- | ----------------------------------------------------------- |
|
|
125
|
+
| `cu tasks` | List my tasks (filter by status, name, type, list, space) |
|
|
126
|
+
| `cu task <id>` | Task details with custom fields and checklists |
|
|
127
|
+
| `cu subtasks <id>` | List subtasks of a task |
|
|
128
|
+
| `cu create` | Create a task or subtask |
|
|
129
|
+
| `cu update <id>` | Update task fields (status, name, priority, assignee, etc.) |
|
|
130
|
+
| `cu delete <id>` | Delete a task (requires confirmation) |
|
|
131
|
+
| `cu assign <id>` | Assign/unassign users |
|
|
132
|
+
| `cu depend <id>` | Add/remove task dependencies |
|
|
133
|
+
| `cu move <id>` | Add/remove task from lists |
|
|
134
|
+
| `cu open <query>` | Open task in browser by ID or name |
|
|
135
|
+
| `cu search <query>` | Search my tasks by name |
|
|
136
|
+
| _`cu duplicate <id>`_ | _Copy a task - coming soon_ |
|
|
137
|
+
| _`cu bulk`_ | _Bulk task operations - coming soon_ |
|
|
138
|
+
|
|
139
|
+
### Sprints & Planning
|
|
140
|
+
|
|
141
|
+
| Command | Description |
|
|
142
|
+
| ------------- | ----------------------------------------------- |
|
|
143
|
+
| `cu sprint` | My tasks in the active sprint (auto-detected) |
|
|
144
|
+
| `cu sprints` | List all sprints |
|
|
145
|
+
| `cu assigned` | All my tasks grouped by status |
|
|
146
|
+
| `cu summary` | Standup helper: completed, in progress, overdue |
|
|
147
|
+
| `cu overdue` | Tasks past their due date |
|
|
148
|
+
| `cu inbox` | Recently updated tasks |
|
|
149
|
+
|
|
150
|
+
### Comments
|
|
151
|
+
|
|
152
|
+
| Command | Description |
|
|
153
|
+
| -------------------------- | -------------------------------- |
|
|
154
|
+
| `cu comment <id>` | Post a comment on a task |
|
|
155
|
+
| `cu comments <id>` | List comments on a task |
|
|
156
|
+
| `cu comment-edit <id>` | Edit an existing comment |
|
|
157
|
+
| `cu activity <id>` | Task details + comments combined |
|
|
158
|
+
| _`cu comment-delete <id>`_ | _Delete a comment - coming soon_ |
|
|
159
|
+
|
|
160
|
+
### Custom Fields
|
|
161
|
+
|
|
162
|
+
| Command | Description |
|
|
163
|
+
| ---------------------- | ----------------------------------------------------------------------------------- |
|
|
164
|
+
| `cu field <id>` | Set/remove custom field values (text, number, dropdown, date, checkbox, url, email) |
|
|
165
|
+
| _`cu fields <listId>`_ | _List available custom fields for a list - coming soon_ |
|
|
166
|
+
|
|
167
|
+
### Checklists
|
|
168
|
+
|
|
169
|
+
| Command | Description |
|
|
170
|
+
| ---------------------------------------- | ------------------------------------------------ |
|
|
171
|
+
| `cu checklist view <id>` | View all checklists on a task |
|
|
172
|
+
| `cu checklist create <id> <name>` | Create a checklist |
|
|
173
|
+
| `cu checklist delete <id>` | Delete a checklist |
|
|
174
|
+
| `cu checklist add-item <id> <name>` | Add item to a checklist |
|
|
175
|
+
| `cu checklist edit-item <id> <itemId>` | Edit a checklist item (name, resolved, assignee) |
|
|
176
|
+
| `cu checklist delete-item <id> <itemId>` | Delete a checklist item |
|
|
177
|
+
|
|
178
|
+
### Tags
|
|
179
|
+
|
|
180
|
+
| Command | Description |
|
|
181
|
+
| --------------------- | --------------------------------------------------- |
|
|
182
|
+
| `cu tag <id>` | Add/remove tags on a task |
|
|
183
|
+
| _`cu tags <spaceId>`_ | _List/create/delete space-level tags - coming soon_ |
|
|
184
|
+
|
|
185
|
+
### Workspace
|
|
186
|
+
|
|
187
|
+
| Command | Description |
|
|
188
|
+
| ------------------------ | ----------------------------------------- |
|
|
189
|
+
| `cu spaces` | List workspace spaces |
|
|
190
|
+
| `cu lists <spaceId>` | Lists in a space (including folder lists) |
|
|
191
|
+
| `cu auth` | Check authentication status |
|
|
192
|
+
| _`cu folders <spaceId>`_ | _List folders in a space - coming soon_ |
|
|
193
|
+
| _`cu members`_ | _List workspace members - coming soon_ |
|
|
194
|
+
|
|
195
|
+
### Time Tracking
|
|
196
|
+
|
|
197
|
+
| Command | Description |
|
|
198
|
+
| ----------------------------- | ----------------------------------------------- |
|
|
199
|
+
| `cu time start <id>` | Start tracking time on a task |
|
|
200
|
+
| `cu time stop` | Stop the running timer |
|
|
201
|
+
| `cu time status` | Show the currently running timer |
|
|
202
|
+
| `cu time log <id> <duration>` | Log a manual time entry (e.g. "2h", "30m") |
|
|
203
|
+
| `cu time list` | List recent time entries (default: last 7 days) |
|
|
204
|
+
|
|
205
|
+
### Setup
|
|
206
|
+
|
|
207
|
+
| Command | Description |
|
|
208
|
+
| ----------------------- | --------------------------------- |
|
|
209
|
+
| `cu init` | First-time setup wizard |
|
|
210
|
+
| `cu config` | Get/set config values |
|
|
211
|
+
| `cu completion <shell>` | Shell completions (bash/zsh/fish) |
|
|
212
|
+
|
|
213
|
+
## Output Modes
|
|
214
|
+
|
|
215
|
+
| Context | Default | Override |
|
|
216
|
+
| -------------- | --------------------------- | ---------------------------- |
|
|
217
|
+
| Terminal (TTY) | Interactive tables + picker | `--json` |
|
|
218
|
+
| Piped (no TTY) | Markdown (optimized for AI) | `--json` or `CU_OUTPUT=json` |
|
|
219
|
+
|
|
220
|
+
Most commands scope to your assigned tasks by default - keeping output small and relevant for agent context windows.
|
|
221
|
+
|
|
222
|
+
## Configuration
|
|
508
223
|
|
|
509
224
|
### Config file
|
|
510
225
|
|
|
@@ -529,6 +244,10 @@ Environment variables override config file values:
|
|
|
529
244
|
|
|
530
245
|
When both are set, the config file is not required. Useful for CI/CD and containerized agents.
|
|
531
246
|
|
|
247
|
+
## Why a CLI and not MCP?
|
|
248
|
+
|
|
249
|
+
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.
|
|
250
|
+
|
|
532
251
|
## Development
|
|
533
252
|
|
|
534
253
|
```bash
|