clickup-agent-cli 0.2.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/marketplace.json +20 -0
- package/.claude-plugin/plugin.json +12 -0
- package/README.md +228 -0
- package/dist/clickup.js +4034 -0
- package/package.json +49 -0
- package/skills/clickup/SKILL.md +125 -0
- package/skills/clickup-blocker-report/SKILL.md +93 -0
- package/skills/clickup-capacity-check/SKILL.md +75 -0
- package/skills/clickup-chat/SKILL.md +58 -0
- package/skills/clickup-comments/SKILL.md +67 -0
- package/skills/clickup-custom-report/SKILL.md +125 -0
- package/skills/clickup-fields/SKILL.md +77 -0
- package/skills/clickup-goal-progress/SKILL.md +74 -0
- package/skills/clickup-goals/SKILL.md +71 -0
- package/skills/clickup-project-setup/SKILL.md +102 -0
- package/skills/clickup-spaces/SKILL.md +88 -0
- package/skills/clickup-sprint-closeout/SKILL.md +91 -0
- package/skills/clickup-sprint-planning/SKILL.md +94 -0
- package/skills/clickup-standup/SKILL.md +94 -0
- package/skills/clickup-task-triage/SKILL.md +86 -0
- package/skills/clickup-tasks/SKILL.md +125 -0
- package/skills/clickup-team-report/SKILL.md +131 -0
- package/skills/clickup-time/SKILL.md +87 -0
- package/skills/clickup-time-audit/SKILL.md +85 -0
- package/skills/clickup-users/SKILL.md +122 -0
- package/skills/clickup-views/SKILL.md +65 -0
- package/skills/clickup-webhooks/SKILL.md +61 -0
- package/skills/clickup-weekly-review/SKILL.md +105 -0
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "clickup-agent-cli",
|
|
3
|
+
"owner": {
|
|
4
|
+
"name": "Henry Reith"
|
|
5
|
+
},
|
|
6
|
+
"metadata": {
|
|
7
|
+
"description": "ClickUp CLI plugin with agent skills for project management"
|
|
8
|
+
},
|
|
9
|
+
"plugins": [
|
|
10
|
+
{
|
|
11
|
+
"name": "clickup",
|
|
12
|
+
"source": "./",
|
|
13
|
+
"description": "ClickUp CLI with 23 agent skills covering the full API -- token-efficient alternative to MCP with chat, time tracking, docs, and project management workflows",
|
|
14
|
+
"version": "0.2.0",
|
|
15
|
+
"homepage": "https://github.com/henryreith/clickup-cli",
|
|
16
|
+
"keywords": ["clickup", "project-management", "tasks", "time-tracking"],
|
|
17
|
+
"category": "productivity"
|
|
18
|
+
}
|
|
19
|
+
]
|
|
20
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "clickup",
|
|
3
|
+
"description": "ClickUp CLI with 23 agent skills covering the full API -- token-efficient alternative to MCP with chat, time tracking, docs, and project management workflows",
|
|
4
|
+
"version": "0.2.0",
|
|
5
|
+
"author": {
|
|
6
|
+
"name": "Henry Reith"
|
|
7
|
+
},
|
|
8
|
+
"homepage": "https://github.com/henryreith/clickup-cli",
|
|
9
|
+
"repository": "https://github.com/henryreith/clickup-cli",
|
|
10
|
+
"license": "MIT",
|
|
11
|
+
"keywords": ["clickup", "project-management", "tasks", "time-tracking", "agile", "sprint"]
|
|
12
|
+
}
|
package/README.md
ADDED
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
# ClickUp CLI
|
|
2
|
+
|
|
3
|
+
A comprehensive, open-source command-line interface for the ClickUp API v2.
|
|
4
|
+
|
|
5
|
+
## Why This Exists
|
|
6
|
+
|
|
7
|
+
ClickUp has no official CLI. Community tools cover fragments of the API surface. This project covers everything: tasks, spaces, folders, lists, comments, time tracking, goals, views, webhooks, user management, custom fields, and more.
|
|
8
|
+
|
|
9
|
+
Built for three audiences:
|
|
10
|
+
- **Humans** who want fast keyboard-driven ClickUp access
|
|
11
|
+
- **AI agents** (Claude Code, OpenAI, custom agents) that need structured ClickUp interaction
|
|
12
|
+
- **Automation scripts** that pipe ClickUp data through standard Unix tools
|
|
13
|
+
|
|
14
|
+
## Quick Start
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
# Install globally
|
|
18
|
+
npm install -g clickup-agent-cli
|
|
19
|
+
|
|
20
|
+
# Authenticate with your personal API token
|
|
21
|
+
clickup auth login --token pk_12345678_ABCDEFG
|
|
22
|
+
|
|
23
|
+
# Set your default workspace
|
|
24
|
+
clickup config set workspace_id 12345678
|
|
25
|
+
|
|
26
|
+
# List your spaces
|
|
27
|
+
clickup space list
|
|
28
|
+
|
|
29
|
+
# List tasks in a list
|
|
30
|
+
clickup task list --list-id 901234567
|
|
31
|
+
|
|
32
|
+
# Create a task
|
|
33
|
+
clickup task create --list-id 901234567 --name "Ship the CLI" --priority 2
|
|
34
|
+
|
|
35
|
+
# Get JSON output (for scripting/agents)
|
|
36
|
+
clickup task list --list-id 901234567 --format json
|
|
37
|
+
|
|
38
|
+
# Pipe task IDs
|
|
39
|
+
clickup task list --list-id 901234567 --format quiet | xargs -I{} clickup task get {}
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## What It Covers
|
|
43
|
+
|
|
44
|
+
| Resource | Commands |
|
|
45
|
+
|----------|----------|
|
|
46
|
+
| Workspaces | list, get, seats, plan, members |
|
|
47
|
+
| Spaces | list, get, create, update, delete |
|
|
48
|
+
| Folders | list, get, create, update, delete |
|
|
49
|
+
| Lists | list, get, create, update, delete, add/remove tasks |
|
|
50
|
+
| Tasks | list, search, get, create, update, delete, time-in-status |
|
|
51
|
+
| Checklists | create, update, delete, manage items |
|
|
52
|
+
| Comments | list, create, update, delete, threading, replies |
|
|
53
|
+
| Custom Fields | list, set, remove |
|
|
54
|
+
| Tags | list, create, update, delete, add/remove from tasks |
|
|
55
|
+
| Dependencies | add, remove |
|
|
56
|
+
| Attachments | upload |
|
|
57
|
+
| Time Tracking | entries, timers, tags, reports |
|
|
58
|
+
| Goals | list, get, create, update, delete, key results |
|
|
59
|
+
| Views | list, get, create, update, delete, view tasks |
|
|
60
|
+
| Users | invite, get, update, remove |
|
|
61
|
+
| User Groups | list, create, update, delete |
|
|
62
|
+
| Guests | invite, manage, permissions |
|
|
63
|
+
| Members | list, find, resolve |
|
|
64
|
+
| Chat | channels, send |
|
|
65
|
+
| Webhooks | list, create, update, delete |
|
|
66
|
+
| Templates | list |
|
|
67
|
+
| Custom Task Types | list |
|
|
68
|
+
|
|
69
|
+
## Output Formats
|
|
70
|
+
|
|
71
|
+
Every command supports multiple output formats:
|
|
72
|
+
|
|
73
|
+
- `--format table` - Human-readable columns (default in terminal)
|
|
74
|
+
- `--format json` - Full API response (default when piped)
|
|
75
|
+
- `--format csv` - Comma-separated values
|
|
76
|
+
- `--format tsv` - Tab-separated values
|
|
77
|
+
- `--format quiet` - IDs only, one per line
|
|
78
|
+
- `--format id` - Single ID (for create commands)
|
|
79
|
+
- `--format md` - Markdown table (ideal for rendering in chat messages or documents)
|
|
80
|
+
|
|
81
|
+
## AI Agent Usage
|
|
82
|
+
|
|
83
|
+
The CLI is built from the ground up for AI agents, following the "CLI as execution layer, skills as guidance layer" pattern. It ships as a Claude Code plugin with 23 agent skills, and works with any agent platform that can run bash commands.
|
|
84
|
+
|
|
85
|
+
**vs ClickUp MCP:** This CLI covers the same operations as the official ClickUp MCP server (tasks, docs, time tracking, chat, members, hierarchy) plus more, while consuming far fewer tokens. A full skills hierarchy loads in ~150 tokens at session start vs injecting an entire API schema. Works in any agent platform that supports bash -- not just MCP-compatible hosts.
|
|
86
|
+
|
|
87
|
+
### Claude Code Plugin (Recommended)
|
|
88
|
+
|
|
89
|
+
Install the ClickUp CLI as a Claude Code plugin for zero-friction access to all skills:
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
# Add the marketplace (one-time)
|
|
93
|
+
/plugin marketplace add henryreith/clickup-cli
|
|
94
|
+
|
|
95
|
+
# Install the plugin
|
|
96
|
+
/plugin install clickup@clickup-cli
|
|
97
|
+
|
|
98
|
+
# Use skills directly
|
|
99
|
+
/clickup:weekly-review 12345678
|
|
100
|
+
/clickup:sprint-planning list-id-here
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Once installed, Claude Code auto-discovers all 23 skills and loads them on demand. Recipe skills like `/clickup:weekly-review` run in isolated subagents with full ClickUp CLI access.
|
|
104
|
+
|
|
105
|
+
### Claude Agent SDK
|
|
106
|
+
|
|
107
|
+
Build custom agents with ClickUp skills using the Agent SDK:
|
|
108
|
+
|
|
109
|
+
```typescript
|
|
110
|
+
import { query } from "@anthropic-ai/claude-agent-sdk";
|
|
111
|
+
|
|
112
|
+
for await (const message of query({
|
|
113
|
+
prompt: "Create a task for the login bug fix and assign to the backend team",
|
|
114
|
+
options: {
|
|
115
|
+
plugins: [{ type: "local", path: "./node_modules/clickup-cli" }],
|
|
116
|
+
allowedTools: ["Skill", "Bash"],
|
|
117
|
+
settingSources: ["project"]
|
|
118
|
+
}
|
|
119
|
+
})) {
|
|
120
|
+
console.log(message);
|
|
121
|
+
}
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### Skills System
|
|
125
|
+
|
|
126
|
+
Instead of injecting a full API schema into every LLM call, agents load a lightweight root skill and fetch deeper context on demand:
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
# Agent reads the root skill at session start (~150 tokens)
|
|
130
|
+
clickup skill show clickup
|
|
131
|
+
|
|
132
|
+
# When it needs to create a task, it loads just the tasks sub-skill (~300 tokens)
|
|
133
|
+
clickup skill show clickup-tasks
|
|
134
|
+
|
|
135
|
+
# Or asks the CLI what fields are needed (~50 tokens in response)
|
|
136
|
+
clickup schema tasks.create
|
|
137
|
+
|
|
138
|
+
# For complex workflows, load a recipe skill
|
|
139
|
+
clickup skill show clickup-weekly-review
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
**Three skill tiers:**
|
|
143
|
+
- **Root skill** - Index and router. What the CLI does, how to discover more.
|
|
144
|
+
- **Sub-skills** (10) - Per-resource command reference. Tasks, spaces, comments, time tracking, chat, etc.
|
|
145
|
+
- **Recipe skills** (12) - Multi-step workflow guides that accept natural language arguments. Scope any recipe to a specific team, department, or person.
|
|
146
|
+
|
|
147
|
+
**Example recipe invocations:**
|
|
148
|
+
```bash
|
|
149
|
+
/clickup:weekly-review marketing team
|
|
150
|
+
/clickup:team-report engineering
|
|
151
|
+
/clickup:standup Sarah's tasks
|
|
152
|
+
/clickup:custom-report all high-priority tasks with no assignee
|
|
153
|
+
/clickup:capacity-check design team
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
### Create Your Own Skills
|
|
157
|
+
|
|
158
|
+
Add custom skills to any project. Create `.claude/skills/<name>/SKILL.md`:
|
|
159
|
+
|
|
160
|
+
```yaml
|
|
161
|
+
---
|
|
162
|
+
name: marketing-weekly
|
|
163
|
+
description: Weekly marketing department review
|
|
164
|
+
disable-model-invocation: true
|
|
165
|
+
context: fork
|
|
166
|
+
agent: general-purpose
|
|
167
|
+
allowed-tools: Bash(clickup *)
|
|
168
|
+
---
|
|
169
|
+
|
|
170
|
+
Generate a marketing department weekly review focused on:
|
|
171
|
+
1. Campaign tasks in the Marketing space (space ID: YOUR_ID)
|
|
172
|
+
2. Content pipeline status
|
|
173
|
+
3. Upcoming launch deadlines
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
This creates `/marketing-weekly` alongside the built-in `/clickup:*` skills.
|
|
177
|
+
|
|
178
|
+
### Cross-Platform Agent Support
|
|
179
|
+
|
|
180
|
+
| Platform | How to use |
|
|
181
|
+
|----------|-----------|
|
|
182
|
+
| Claude Code | Plugin via marketplace (see above) |
|
|
183
|
+
| Claude Agent SDK | `plugins: [{ type: "local", path: "./node_modules/clickup-cli" }]` |
|
|
184
|
+
| Gemini CLI | `npm install -g clickup-agent-cli`, read skills via `clickup skill show` |
|
|
185
|
+
| OpenAI Codex | `npm install -g clickup-agent-cli`, execute commands via bash |
|
|
186
|
+
| Custom agents | `clickup skill list` for discovery, `clickup schema` for field info |
|
|
187
|
+
|
|
188
|
+
### Agent-Friendly Design
|
|
189
|
+
|
|
190
|
+
- JSON is the default output when stdout is not a TTY
|
|
191
|
+
- `clickup schema <resource>.<action>` for runtime field discovery
|
|
192
|
+
- Predictable exit codes (0-7) for error branching
|
|
193
|
+
- `--dry-run` to preview actions before executing
|
|
194
|
+
- No interactive prompts in non-TTY mode
|
|
195
|
+
- All non-data output (spinners, errors) goes to stderr
|
|
196
|
+
- Composable with standard Unix tools
|
|
197
|
+
|
|
198
|
+
### Quick Agent Example
|
|
199
|
+
|
|
200
|
+
```bash
|
|
201
|
+
# Discover what's available
|
|
202
|
+
clickup schema tasks
|
|
203
|
+
|
|
204
|
+
# Check what fields task create needs
|
|
205
|
+
clickup schema tasks.create --format json
|
|
206
|
+
|
|
207
|
+
# Create a task (JSON output automatic in non-TTY)
|
|
208
|
+
clickup task create --list-id 998877 --name "Review PR" --priority 2
|
|
209
|
+
|
|
210
|
+
# Compose: create task then comment on it
|
|
211
|
+
TASK_ID=$(clickup task create --list-id 998877 --name "Fix bug" --format id)
|
|
212
|
+
clickup comment create --task-id "$TASK_ID" --text "Starting work"
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
## Documentation
|
|
216
|
+
|
|
217
|
+
- [Technical Specification](./SPEC.md) - Architecture, patterns, and design decisions
|
|
218
|
+
- [Command Reference](./COMMANDS.md) - Every command, flag, and option
|
|
219
|
+
- [Implementation Plan](./IMPLEMENTATION.md) - Phased build order
|
|
220
|
+
- [CLAUDE.md](./CLAUDE.md) - Coding conventions for AI agents building this project
|
|
221
|
+
|
|
222
|
+
## Tech Stack
|
|
223
|
+
|
|
224
|
+
TypeScript, Node.js 22+, Commander.js, Zod, chalk, ora, cli-table3, conf, tsup, vitest.
|
|
225
|
+
|
|
226
|
+
## License
|
|
227
|
+
|
|
228
|
+
MIT
|