@krodak/clickup-cli 1.19.4 → 1.20.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/.claude-plugin/plugin.json +1 -1
- package/README.md +19 -0
- package/dist/index.js +2146 -157
- package/package.json +1 -1
- package/skills/clickup-cli/SKILL.md +60 -3
- package/dist/chunk-HCGKTH6V.js +0 -2063
- package/dist/sprint-NLMMC4RB.js +0 -19
package/package.json
CHANGED
|
@@ -9,13 +9,70 @@ Reference for AI agents using the `cup` CLI tool. Covers task management, sprint
|
|
|
9
9
|
|
|
10
10
|
> **Version check:** Run `cup --version`. If your installed version is older than 1.18.0, update with `npm install -g @krodak/clickup-cli` and refresh this skill with `cup skill`.
|
|
11
11
|
|
|
12
|
+
## Install & Configure
|
|
13
|
+
|
|
14
|
+
### Prerequisites
|
|
15
|
+
|
|
16
|
+
Node.js 22+ required.
|
|
17
|
+
|
|
18
|
+
### Install
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npm install -g @krodak/clickup-cli
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Or via Homebrew:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
brew tap krodak/tap && brew install clickup-cli
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Get an API token
|
|
31
|
+
|
|
32
|
+
The user needs a personal API token from ClickUp:
|
|
33
|
+
|
|
34
|
+
1. Open https://app.clickup.com/settings/apps
|
|
35
|
+
2. Under "API Token", click "Generate" (or copy existing)
|
|
36
|
+
3. The token starts with `pk_`
|
|
37
|
+
|
|
38
|
+
### Configure
|
|
39
|
+
|
|
40
|
+
**Non-interactive (recommended for agents):**
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
cup init --token pk_USER_TOKEN --team TEAM_ID
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
To find the team/workspace ID, the user can check their ClickUp URL: `https://app.clickup.com/TEAM_ID/...`
|
|
47
|
+
|
|
48
|
+
**Interactive (for humans in a terminal):**
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
cup init
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
**Environment variables (no config file needed):**
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
export CU_API_TOKEN="pk_..."
|
|
58
|
+
export CU_TEAM_ID="12345678"
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Verify
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
cup auth
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
This prints the authenticated username and workspace. If it fails, the token or config is invalid.
|
|
68
|
+
|
|
12
69
|
## Setup
|
|
13
70
|
|
|
14
|
-
Config at `~/.config/cup/config.json` with named profiles. Each profile has `apiToken` and `teamId`. Optional: `sprintFolderId` to pin sprint detection to a specific folder.
|
|
71
|
+
Config stored at `~/.config/cup/config.json` with named profiles. Each profile has `apiToken` and `teamId`. Optional: `sprintFolderId` to pin sprint detection to a specific folder.
|
|
15
72
|
|
|
16
73
|
Multiple profiles supported - use `cup profile add <name>` to create, `cup profile use <name>` to switch, or `-p <name>` flag for one-off overrides.
|
|
17
74
|
|
|
18
|
-
|
|
75
|
+
`CU_PROFILE` environment variable selects a profile (overridden by `-p` flag).
|
|
19
76
|
|
|
20
77
|
## Saved Filters (Quick Shortcuts)
|
|
21
78
|
|
|
@@ -92,7 +149,7 @@ All commands support `--help` for full flag details. All commands support `--jso
|
|
|
92
149
|
| `cup update <id> [-n name] [-d desc] [-s status] [--priority p] [--due-date d\|none] [--start-date d] [--time-estimate t] [--assignee id\|me] [--remove-assignee id\|me] [--parent id] [--detach] [--archive] [--unarchive] [--field "Name" val]` | Update task fields (including custom fields) |
|
|
93
150
|
| `cup comment <id> -m text [--notify-all]` | Post comment on task |
|
|
94
151
|
| `cup comment-edit <commentId> -m text [--resolved] [--unresolved]` | Edit a comment |
|
|
95
|
-
| `cup comment-delete <commentId>
|
|
152
|
+
| `cup comment-delete <commentId>` or `cup comment-delete --task <taskId> --mine [--match text]` | Delete a comment by ID or delete one of your task comments |
|
|
96
153
|
| `cup replies <commentId>` | List threaded replies |
|
|
97
154
|
| `cup reply <commentId> -m text [--notify-all]` | Reply to a comment |
|
|
98
155
|
| `cup assign <id> [--to userId\|me] [--remove userId\|me]` | Assign/unassign users |
|