@krodak/clickup-cli 1.5.2 → 1.6.1

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.
Files changed (5) hide show
  1. package/.claude-plugin/plugin.json +1 -1
  2. package/README.md +62 -59
  3. package/dist/index.js +421 -113
  4. package/package.json +1 -1
  5. package/skills/clickup-cli/SKILL.md +24 -2
package/.claude-plugin/plugin.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "clickup-cli",
3
3
  "description": "ClickUp CLI skills for managing tasks, sprints, comments, checklists, custom fields, tags, and time tracking via the cup command",
4
- "version": "1.5.2",
4
+ "version": "1.6.1",
5
5
  "author": {
6
6
  "name": "Krzysztof Rodak"
7
7
  },
package/README.md CHANGED
@@ -1,18 +1,19 @@
1
- # cup - ClickUp CLI
2
-
3
- > A ClickUp CLI built for AI agents that also works well for humans. Outputs Markdown when piped (optimized for AI context windows), interactive tables when run in a terminal.
4
-
5
- [![npm](https://img.shields.io/npm/v/@krodak/clickup-cli)](https://www.npmjs.com/package/@krodak/clickup-cli)
6
- [![node](https://img.shields.io/node/v/@krodak/clickup-cli)](https://nodejs.org)
7
- [![license](https://img.shields.io/npm/l/@krodak/clickup-cli)](./LICENSE)
8
- [![CI](https://github.com/krodak/clickup-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/krodak/clickup-cli/actions/workflows/ci.yml)
1
+ <p align="center">
2
+ <img src="banner.png" alt="cup - ClickUp CLI for AI agents (and humans)" width="100%">
3
+ </p>
4
+
5
+ <p align="center">
6
+ <a href="https://www.npmjs.com/package/@krodak/clickup-cli"><img src="https://img.shields.io/npm/v/@krodak/clickup-cli" alt="npm"></a>
7
+ <a href="https://nodejs.org"><img src="https://img.shields.io/node/v/@krodak/clickup-cli" alt="node"></a>
8
+ <a href="./LICENSE"><img src="https://img.shields.io/npm/l/@krodak/clickup-cli" alt="license"></a>
9
+ <a href="https://github.com/krodak/clickup-cli/actions/workflows/ci.yml"><img src="https://github.com/krodak/clickup-cli/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
10
+ <a href="https://github.com/krodak/homebrew-tap"><img src="https://img.shields.io/badge/homebrew-tap-FBB040?logo=homebrew&logoColor=black" alt="homebrew"></a>
11
+ </p>
9
12
 
10
13
  ```bash
11
14
  npm install -g @krodak/clickup-cli && cup init
12
15
  ```
13
16
 
14
- `cup` is the binary name. The previous `cu` name was retired in v0.21.0 to avoid conflict with the Unix [cu(1)](<https://en.wikipedia.org/wiki/Cu_(Unix_utility)>) utility.
15
-
16
17
  ## Talk to your agent
17
18
 
18
19
  Install the CLI, add the skill file to your agent, and it works with ClickUp. No API knowledge needed.
@@ -29,6 +30,18 @@ Install the CLI, add the skill file to your agent, and it works with ClickUp. No
29
30
 
30
31
  The agent reads the skill file, picks the right `cup` commands, and handles everything. You don't need to learn the CLI - the agent does.
31
32
 
33
+ ### Agent mode
34
+
35
+ When piped (no TTY), output is Markdown optimized for AI context windows. Pass `--json` for structured data.
36
+
37
+ ![Agent Mode - markdown and JSON output](demos/agent-mode.gif)
38
+
39
+ ### Terminal mode
40
+
41
+ In a terminal, you get interactive tables with colors. Most commands scope to your assigned tasks by default.
42
+
43
+ ![TTY Mode - interactive tables and detail views](demos/tty-mode.gif)
44
+
32
45
  ## Why a CLI and not MCP?
33
46
 
34
47
  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.
@@ -130,40 +143,35 @@ The skill file follows the [Agent Skills](https://agentskills.io) open standard.
130
143
 
131
144
  Full CRUD for the core ClickUp workflow:
132
145
 
133
- **Tasks** - create, read, update, delete, duplicate, search, subtasks, assign, dependencies, links, multi-list, bulk status updates
134
-
135
- **Comments** - post, edit, delete, threaded replies, notify all
136
-
137
- **Docs** - list, read, create, edit, delete (v3 API)
138
-
139
- **Time Tracking** - start/stop timer, log entries, list/update/delete history
140
-
141
- **Checklists** - view, create, delete, add/edit/delete items
142
-
143
- **Custom Fields** - list, set, remove values (dropdown, date, checkbox, text, etc.)
144
-
145
- **Tags** - add/remove on tasks, space-level create/update/delete
146
-
147
- **Goals & OKRs** - goals CRUD, key results CRUD
148
-
149
- **Sprints** - auto-detect active sprint, flexible date parsing, config override
150
-
151
- **Workspace** - spaces, folders, lists, members, task types, templates
152
-
153
- **Attachments** - upload files to tasks, shown in detail views
146
+ | Area | Capabilities |
147
+ | -------------------- | ----------------------------------------------------------------------------------------------------------------------- |
148
+ | ✅ **Tasks** | Create, read, update, delete, duplicate, search, subtasks, assign, dependencies, links, multi-list, bulk status updates |
149
+ | 💬 **Comments** | Post, edit, delete, threaded replies, notify all |
150
+ | 📄 **Docs** | List, read, create, edit, delete (v3 API) |
151
+ | ⏱️ **Time Tracking** | Start/stop timer, log entries, list/update/delete history |
152
+ | ☑️ **Checklists** | View, create, delete, add/edit/delete items |
153
+ | 🔧 **Custom Fields** | List, set, remove values (dropdown, date, checkbox, text, etc.) |
154
+ | 🏷️ **Tags** | Add/remove on tasks, space-level create/update/delete |
155
+ | 🎯 **Goals & OKRs** | Goals CRUD, key results CRUD |
156
+ | 🏃 **Sprints** | Auto-detect active sprint, flexible date parsing, config override |
157
+ | 🏢 **Workspace** | Spaces, folders, lists, members, task types, templates |
158
+ | 📎 **Attachments** | Upload files to tasks, shown in detail views |
154
159
 
155
160
  [Full API coverage details](docs/api-coverage.md) | [Command reference](docs/commands.md)
156
161
 
157
- ## Output Modes
162
+ ## Configuration
158
163
 
159
- | Context | Default | Override |
160
- | -------------- | --------------------------- | ---------------------------- |
161
- | Terminal (TTY) | Interactive tables + picker | `--json` |
162
- | Piped (no TTY) | Markdown (optimized for AI) | `--json` or `CU_OUTPUT=json` |
164
+ ### Profiles
163
165
 
164
- Most commands scope to your assigned tasks by default - keeping output small and relevant for agent context windows.
166
+ Multiple profiles for different workspaces or accounts:
165
167
 
166
- ## Configuration
168
+ ```bash
169
+ cup profile add work # interactive setup
170
+ cup profile add personal # another workspace
171
+ cup profile list # show all profiles
172
+ cup profile use personal # switch default
173
+ cup tasks -p work # one-off profile override
174
+ ```
167
175
 
168
176
  ### Config file
169
177
 
@@ -171,12 +179,23 @@ Most commands scope to your assigned tasks by default - keeping output small and
171
179
 
172
180
  ```json
173
181
  {
174
- "apiToken": "pk_...",
175
- "teamId": "12345678",
176
- "sprintFolderId": "optional - folder ID to skip auto-detection"
182
+ "defaultProfile": "work",
183
+ "profiles": {
184
+ "work": {
185
+ "apiToken": "pk_...",
186
+ "teamId": "12345678",
187
+ "sprintFolderId": "optional"
188
+ },
189
+ "personal": {
190
+ "apiToken": "pk_...",
191
+ "teamId": "87654321"
192
+ }
193
+ }
177
194
  }
178
195
  ```
179
196
 
197
+ Old flat configs (pre-profiles) are auto-migrated on first load.
198
+
180
199
  ### Environment variables
181
200
 
182
201
  Environment variables override config file values:
@@ -185,26 +204,10 @@ Environment variables override config file values:
185
204
  | -------------- | ----------------------------------------------------------------- |
186
205
  | `CU_API_TOKEN` | ClickUp personal API token (`pk_`) |
187
206
  | `CU_TEAM_ID` | Workspace (team) ID |
207
+ | `CU_PROFILE` | Profile name (overrides `defaultProfile`, overridden by `-p`) |
188
208
  | `CU_OUTPUT` | Set to `json` to force JSON output when piped (default: markdown) |
189
209
 
190
- When both are set, the config file is not required. Useful for CI/CD and containerized agents.
191
-
192
- ## Custom Task IDs
193
-
194
- 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.
195
-
196
- All commands that accept task IDs work with both native IDs and custom IDs:
197
-
198
- ```bash
199
- cup task PROJ-123
200
- cup update DEV-42 --status done
201
- cup comment PROJ-456 -m "Fixed in latest commit"
202
- cup subtasks DEV-100
203
- ```
204
-
205
- Custom ID resolution uses the `teamId` from your config, which is required (`cup init` sets it up).
206
-
207
- **Task links with custom IDs:** The `cup 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.
210
+ When both `CU_API_TOKEN` and `CU_TEAM_ID` are set, the config file is not required. Useful for CI/CD and containerized agents.
208
211
 
209
212
  ## Development
210
213