clickup-agent-cli 0.5.1 → 0.5.2
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/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +1 -1
- package/AGENTS.md +61 -0
- package/LICENSE +21 -0
- package/README.md +7 -1
- package/dist/clickup.js +1 -1
- package/package.json +4 -3
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"name": "clickup",
|
|
12
12
|
"source": "./",
|
|
13
13
|
"description": "ClickUp CLI with 31 agent skills covering the full API -- token-efficient alternative to MCP with chat, time tracking, docs, and project management workflows",
|
|
14
|
-
"version": "0.5.
|
|
14
|
+
"version": "0.5.2",
|
|
15
15
|
"homepage": "https://github.com/henryreith/clickup-cli",
|
|
16
16
|
"keywords": ["clickup", "project-management", "tasks", "time-tracking"],
|
|
17
17
|
"category": "productivity"
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "clickup",
|
|
3
3
|
"description": "ClickUp CLI with 31 agent skills covering the full API -- token-efficient alternative to MCP with chat, time tracking, docs, and project management workflows",
|
|
4
|
-
"version": "0.5.
|
|
4
|
+
"version": "0.5.2",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Henry Reith"
|
|
7
7
|
},
|
package/AGENTS.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# ClickUp CLI: Agent Operating Manual
|
|
2
|
+
|
|
3
|
+
You have (or can install) `clickup`, a command-line tool covering the full ClickUp API v2. This file is the fastest path from zero to productive for any agent on any platform. Everything here works headless.
|
|
4
|
+
|
|
5
|
+
## Setup
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g clickup-agent-cli
|
|
9
|
+
|
|
10
|
+
# Authenticate: env var (preferred for agents), --token-file, or --token per call
|
|
11
|
+
export CLICKUP_API_TOKEN=pk_your_token
|
|
12
|
+
|
|
13
|
+
# Verify auth and workspace resolution
|
|
14
|
+
clickup config validate
|
|
15
|
+
|
|
16
|
+
# One-time workspace binding (auto-selects when the account has one workspace)
|
|
17
|
+
clickup workspace setup
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Discover, never guess
|
|
21
|
+
|
|
22
|
+
Do not guess command syntax. The CLI is self-describing:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
clickup skill show clickup # Root skill: index of all capabilities (~150 tokens)
|
|
26
|
+
clickup skill list # All 31 skills (12 resource references, 18 workflows)
|
|
27
|
+
clickup skill show <name> # Full skill content (JSON with a "content" field when piped)
|
|
28
|
+
clickup skill path <name> # Skill directory: bundled references/, assets/, scripts/
|
|
29
|
+
clickup schema <resource> # Actions for a resource (task, list, doc, time, ...)
|
|
30
|
+
clickup schema <resource>.<action> # Required and optional flags for one action
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Skills bundle supporting files per the Agent Skills standard: `assets/report-template.md` (copy the structure for report output), `scripts/*.mjs` (deterministic helpers; pipe JSON in via node), and `references/` (deep detail such as `clickup skill path clickup`/references/gotchas.md).
|
|
34
|
+
|
|
35
|
+
## Conventions that matter
|
|
36
|
+
|
|
37
|
+
- **Output**: JSON by default when piped; force with `--format json|table|csv|tsv|quiet|id|md`. `--format id` prints just the first result's ID for capture: `ID=$(clickup task create ... --format id)`.
|
|
38
|
+
- **Exit codes**: 0 ok, 1 general, 2 bad arguments, 3 auth, 4 not found, 5 permission, 6 rate limited, 7 network. Branch on these.
|
|
39
|
+
- **Destructive commands** (`* delete`, `field remove`, `time delete`) require `--confirm` when non-interactive. Pass it deliberately; never bypass a confirmation you were not asked to give.
|
|
40
|
+
- **Dates**: Unix ms/seconds, ISO 8601 (`2026-07-10`), or relative (`today`, `tomorrow`, `3d`, `-1w`, `friday`). Filter flags ending `-gt`/`-lt` take Unix ms only.
|
|
41
|
+
- **Rate limits**: ~100 requests/min; 429s retry automatically. Prefer `task bulk-update`/`task bulk-delete` for batches.
|
|
42
|
+
- **Dry runs**: add `--dry-run` to print the exact request without sending it.
|
|
43
|
+
- Errors and spinners go to stderr; stdout is data only. Safe to pipe.
|
|
44
|
+
|
|
45
|
+
## Quick example
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
# Find the list, create a task, comment on it
|
|
49
|
+
LIST_ID=$(clickup list list --space-id 123 --filter name="Sprint 12" --format id)
|
|
50
|
+
TASK_ID=$(clickup task create --list-id "$LIST_ID" --name "Fix login redirect" \
|
|
51
|
+
--priority high --due-date friday --format id)
|
|
52
|
+
clickup comment create --task-id "$TASK_ID" --text "Repro steps in thread"
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## For Claude Code specifically
|
|
56
|
+
|
|
57
|
+
Install as a plugin instead: `/plugin marketplace add henryreith/clickup-cli` then `/plugin install clickup@clickup-agent-cli`. Skills load natively (`/clickup:weekly-review`, etc.).
|
|
58
|
+
|
|
59
|
+
## Developing this repo
|
|
60
|
+
|
|
61
|
+
Build/test conventions live in [CLAUDE.md](./CLAUDE.md): `npm run typecheck && npm test && npm run build && npm run lint:skills` must pass. The full command reference is [COMMANDS.md](./COMMANDS.md); architecture is [SPEC.md](./SPEC.md).
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Henry Reith
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# ClickUp CLI
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/clickup-agent-cli)
|
|
4
|
+
[](https://nodejs.org)
|
|
5
|
+
[](https://github.com/henryreith/clickup-cli/actions/workflows/ci.yml)
|
|
6
|
+
[](./LICENSE)
|
|
7
|
+
[](./skills)
|
|
8
|
+
|
|
3
9
|
Zero-overhead CLI for the ClickUp API v2 -- for AI agents, scripts, and automation. Covers the entire API surface with all MCP capabilities and more.
|
|
4
10
|
|
|
5
11
|
## Why This Exists
|
|
@@ -187,7 +193,7 @@ This creates `/marketing-weekly` alongside the built-in `/clickup:*` skills.
|
|
|
187
193
|
|
|
188
194
|
### Bootstrap From Any Agent
|
|
189
195
|
|
|
190
|
-
Any agent that can run shell commands can set up and use the CLI in five steps, no plugin system required:
|
|
196
|
+
The repo and npm package ship an [AGENTS.md](./AGENTS.md) operating manual that agent platforms (Codex, Cursor, Gemini CLI, custom agents) pick up automatically. Any agent that can run shell commands can set up and use the CLI in five steps, no plugin system required:
|
|
191
197
|
|
|
192
198
|
```bash
|
|
193
199
|
# 1. Install
|
package/dist/clickup.js
CHANGED
|
@@ -4629,7 +4629,7 @@ function registerChatCommands(program, getClient) {
|
|
|
4629
4629
|
}
|
|
4630
4630
|
|
|
4631
4631
|
// src/cli.ts
|
|
4632
|
-
var VERSION = "0.5.
|
|
4632
|
+
var VERSION = "0.5.2";
|
|
4633
4633
|
function createProgram() {
|
|
4634
4634
|
const program = new Command();
|
|
4635
4635
|
program.name("clickup").description("ClickUp CLI - Manage ClickUp workspaces from the terminal").version(VERSION).option("--token <token>", "API token").option("--token-file <path>", "Read API token from this file path").option("--profile <name>", "Profile to use (key, workspace name, or nickname)").option("--workspace-id <id>", "Workspace ID").addOption(
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "clickup-agent-cli",
|
|
3
|
-
"version": "0.5.
|
|
4
|
-
"description": "CLI
|
|
3
|
+
"version": "0.5.2",
|
|
4
|
+
"description": "Zero-overhead ClickUp CLI for AI agents, shell scripts, and automation. Full ClickUp API v2 coverage with 31 bundled agent skills.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
7
7
|
"clickup": "dist/clickup.js"
|
|
@@ -9,7 +9,8 @@
|
|
|
9
9
|
"files": [
|
|
10
10
|
"dist",
|
|
11
11
|
"skills",
|
|
12
|
-
".claude-plugin"
|
|
12
|
+
".claude-plugin",
|
|
13
|
+
"AGENTS.md"
|
|
13
14
|
],
|
|
14
15
|
"engines": {
|
|
15
16
|
"node": ">=22.0.0"
|