Skip to content

Commit eaef06f

Browse files
isaacrowntreeclaude
andcommitted
docs: streamline README and commands.md, link to auto-generated reference
README now links to the docs site for detailed usage instead of duplicating configuration, CI, GitHub Actions, and AI agent sections. commands.md replaced with a concise overview table linking to auto-generated reference pages (850 lines → 120 lines). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 3353031 commit eaef06f

File tree

2 files changed

+94
-1067
lines changed

2 files changed

+94
-1067
lines changed

README.md

Lines changed: 15 additions & 253 deletions
Original file line numberDiff line numberDiff line change
@@ -87,272 +87,34 @@ Link your current GitHub PR to the task:
8787
clickup link pr
8888
```
8989

90-
## Command reference
91-
92-
### Core commands
93-
94-
| Command | Description |
95-
|---------|-------------|
96-
| `clickup task view [task-id]` | View task details (auto-detects from branch) |
97-
| `clickup task list --list-id ID` | List tasks with optional filters |
98-
| `clickup task create --list-id ID` | Create a new task (interactive or flags) |
99-
| `clickup task edit [task-id]` | Edit task fields (name, status, priority, dates, tags with `--add-tags`/`--remove-tags`, points, custom fields, etc.) |
100-
| `clickup task delete <task-id>` | Delete a task permanently |
101-
| `clickup task search <query>` | Search tasks with fuzzy matching |
102-
| `clickup task recent` | Show your recently updated tasks with folder/list context |
103-
| `clickup task list-add <task-id>... --list-id ID` | Add tasks to an additional list |
104-
| `clickup task list-remove <task-id>... --list-id ID` | Remove tasks from a list |
105-
| `clickup task activity [task-id]` | View task details and comment history |
106-
| `clickup task time log [task-id]` | Log time to a task |
107-
| `clickup task time list [task-id]` | View time entries for a task or date range (timesheet) |
108-
| `clickup task time delete <entry-id>` | Delete a time entry |
109-
| `clickup task dependency add/remove` | Manage task dependencies (depends-on, blocks) |
110-
| `clickup task checklist add/remove` | Manage task checklists and checklist items |
111-
| `clickup comment add [task-id]` | Add a comment to a task |
112-
| `clickup comment list [task-id]` | List comments on a task |
113-
| `clickup comment edit` | Edit an existing comment |
114-
| `clickup comment delete` | Delete a comment |
115-
| `clickup status set STATUS [task-id]` | Change task status with fuzzy matching |
116-
| `clickup status list` | List available statuses for a space |
117-
| `clickup status add <name>` | Add a new status to a space |
118-
| `clickup field list --list-id ID` | List available custom fields for a list |
119-
| `clickup tag list` | List available tags for a space |
120-
121-
### Workflow commands
122-
123-
| Command | Description |
124-
|---------|-------------|
125-
| `clickup link pr [NUMBER]` | Link a GitHub PR to a ClickUp task |
126-
| `clickup link sync [NUMBER]` | Sync ClickUp task info into a GitHub PR body (and link back) |
127-
| `clickup link branch` | Link the current git branch to a task |
128-
| `clickup link commit [SHA]` | Link a git commit to a task |
129-
| `clickup sprint current` | Show tasks in the active sprint |
130-
| `clickup sprint list` | List sprints in the sprint folder |
131-
| `clickup inbox` | Show recent @mentions in comments and task descriptions |
132-
133-
### Setup commands
134-
135-
| Command | Description |
136-
|---------|-------------|
137-
| `clickup auth login` | Authenticate (token prompt, `--oauth`, or `--with-token` for CI) |
138-
| `clickup auth logout` | Remove stored credentials |
139-
| `clickup auth status` | Show current authentication state (includes user ID) |
140-
| `clickup space list` | List spaces in your workspace |
141-
| `clickup space select` | Interactively select a default space |
142-
| `clickup member list` | List workspace members with IDs, usernames, emails, and roles |
143-
144-
### Utility commands
145-
146-
| Command | Description |
147-
|---------|-------------|
148-
| `clickup version` | Print version, commit, and build date |
149-
| `clickup completion SHELL` | Generate shell completion scripts |
150-
151-
## Configuration
152-
153-
Configuration is stored in `~/.config/clickup/config.yml`. The file is created automatically during `clickup auth login`.
154-
155-
```yaml
156-
workspace: "1234567"
157-
space: "89012345"
158-
sprint_folder: "67890123"
159-
editor: "vim"
160-
aliases:
161-
v: task view
162-
s: sprint current
163-
directory_defaults:
164-
/home/user/projects/api:
165-
space: "11111111"
166-
```
90+
## Command overview
16791

168-
| Field | Description |
169-
|-------|-------------|
170-
| `workspace` | Default workspace (team) ID |
171-
| `space` | Default space ID |
172-
| `sprint_folder` | Folder ID containing sprint lists |
173-
| `editor` | Editor for interactive descriptions |
174-
| `prompt` | Controls interactive prompts (`"enabled"` by default) |
175-
| `aliases` | Custom command aliases |
176-
| `directory_defaults` | Per-directory space overrides |
92+
| Area | Key commands |
93+
|------|-------------|
94+
| **Tasks** | `task view`, `task list`, `task create`, `task edit`, `task search`, `task recent`, `task delete` |
95+
| **Time tracking** | `task time log`, `task time list`, `task time delete` |
96+
| **Comments** | `comment add`, `comment list`, `comment edit`, `comment delete` |
97+
| **Status** | `status set`, `status list`, `status add` |
98+
| **Git & GitHub** | `link pr`, `link sync`, `link branch`, `link commit` |
99+
| **Sprints** | `sprint current`, `sprint list` |
100+
| **Workspace** | `inbox`, `member list`, `space list`, `space select`, `tag list`, `field list` |
101+
| **Auth** | `auth login`, `auth logout`, `auth status` |
177102

178-
The config directory can be overridden with the `CLICKUP_CONFIG_DIR` environment variable.
103+
All list/view commands support `--json` and `--jq` for scripting. See the [full command reference](https://triptechtravel.github.io/clickup-cli/commands/) for flags, examples, and detailed usage.
179104

180105
## Git integration
181106

182-
The CLI auto-detects ClickUp task IDs from your current git branch name. Two patterns are recognized:
183-
184-
- **`CU-<id>`** -- default ClickUp task IDs (e.g., `CU-ae27de`, `CU-86d1u2bz4`)
185-
- **`PREFIX-<number>`** -- custom task IDs (e.g., `PROJ-42`, `ENG-1234`)
186-
187-
Standard branch prefixes like `feature/`, `fix/`, `hotfix/`, `bugfix/`, `chore/`, and others are stripped before matching.
188-
189-
Name your branches with the task ID included:
107+
The CLI auto-detects ClickUp task IDs from branch names (`CU-abc123` or `PROJ-42`). Name your branches with the task ID:
190108

191109
```sh
192110
git checkout -b feature/CU-ae27de-add-user-auth
193-
git checkout -b fix/PROJ-42-login-bug
194-
```
195-
196-
Then commands like `task view`, `task edit`, `status set`, `link pr`, `link branch`, and `link commit` will automatically target the correct task without requiring an explicit ID argument.
197-
198-
### GitHub CLI dependency
199-
200-
The `link pr` command requires the [GitHub CLI](https://cli.github.com/) (`gh`) to be installed and authenticated. It uses `gh pr view` to resolve pull request details.
201-
202-
## Shell completions
203-
204-
Generate completion scripts for your shell:
205-
206-
```sh
207-
# Bash
208-
source <(clickup completion bash)
209-
210-
# Zsh
211-
source <(clickup completion zsh)
212-
# Or install permanently:
213-
clickup completion zsh > "${fpath[1]}/_clickup"
214-
215-
# Fish
216-
clickup completion fish | source
217-
218-
# PowerShell
219-
clickup completion powershell | Out-String | Invoke-Expression
220-
```
221-
222-
## CI usage
223-
224-
For non-interactive environments, pipe a token via stdin:
225-
226-
```sh
227-
echo "$CLICKUP_TOKEN" | clickup auth login --with-token
228-
```
229-
230-
All list and view commands support `--json` for machine-readable output, and `--jq` for inline filtering:
231-
232-
```sh
233-
clickup task view CU-abc123 --json
234-
clickup sprint current --json --jq '.[].name'
235-
```
236-
237-
## Using with AI coding agents
238-
239-
The CLI is designed to work well with AI agents like Claude Code, GitHub Copilot, and Cursor. An AI agent can read task context from ClickUp, make code changes, and update ClickUp -- all without leaving the terminal.
240-
241-
```sh
242-
# AI agent discovers where work is happening
243-
clickup task recent --json
244-
245-
# AI agent reads the task to understand requirements
246-
clickup task view CU-abc123 --json
247-
248-
# Search within a specific folder/list discovered from recent tasks
249-
clickup task search "migration" --folder "Engineering Sprint"
250-
251-
# After making changes, the agent updates ClickUp
252-
clickup status set "code review" CU-abc123
253-
clickup comment add CU-abc123 "Implemented the feature, PR is up for review"
254-
clickup link sync --task CU-abc123
255-
```
256-
257-
The `--json` flag on all commands outputs structured data that agents can parse. The `--task` and `--repo` flags on link commands allow targeting any task/repo without needing to be on the right branch.
258-
259-
When search returns no results, the CLI suggests `clickup task recent` to help discover active lists and folders. The `task recent` command shows each task's folder and list, so agents can quickly identify where to narrow their search.
260-
261-
## GitHub Actions
262-
263-
Automate ClickUp updates on PR events by adding workflow files to your repository. Copy these from the [`examples/`](https://github.com/triptechtravel/clickup-cli/tree/main/examples) directory or use them as a starting point.
264-
265-
### Sync task info on PR open
266-
267-
```yaml
268-
# .github/workflows/clickup-sync.yml
269-
name: ClickUp Sync
270-
on:
271-
pull_request:
272-
types: [opened, synchronize]
273-
274-
jobs:
275-
sync:
276-
runs-on: ubuntu-latest
277-
steps:
278-
- uses: actions/checkout@v4
279-
- name: Install clickup CLI
280-
run: |
281-
curl -sL https://github.com/triptechtravel/clickup-cli/releases/latest/download/clickup_linux_amd64.tar.gz | tar xz
282-
sudo mv clickup /usr/local/bin/
283-
- name: Authenticate
284-
run: echo "${{ secrets.CLICKUP_TOKEN }}" | clickup auth login --with-token
285-
- name: Sync PR with ClickUp task
286-
run: clickup link sync ${{ github.event.pull_request.number }}
287-
env:
288-
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
289-
```
290-
291-
### Set status to "done" on merge
292-
293-
```yaml
294-
# .github/workflows/clickup-done.yml
295-
name: ClickUp Done
296-
on:
297-
pull_request:
298-
types: [closed]
299-
300-
jobs:
301-
done:
302-
if: github.event.pull_request.merged == true
303-
runs-on: ubuntu-latest
304-
steps:
305-
- uses: actions/checkout@v4
306-
- name: Install clickup CLI
307-
run: |
308-
curl -sL https://github.com/triptechtravel/clickup-cli/releases/latest/download/clickup_linux_amd64.tar.gz | tar xz
309-
sudo mv clickup /usr/local/bin/
310-
- name: Authenticate
311-
run: echo "${{ secrets.CLICKUP_TOKEN }}" | clickup auth login --with-token
312-
- name: Set task to done
313-
run: clickup status set "done"
314-
```
315-
316-
### Comment CI results on task
317-
318-
```yaml
319-
# .github/workflows/clickup-ci.yml
320-
name: ClickUp CI Status
321-
on:
322-
check_suite:
323-
types: [completed]
324-
325-
jobs:
326-
notify:
327-
runs-on: ubuntu-latest
328-
steps:
329-
- uses: actions/checkout@v4
330-
- name: Install clickup CLI
331-
run: |
332-
curl -sL https://github.com/triptechtravel/clickup-cli/releases/latest/download/clickup_linux_amd64.tar.gz | tar xz
333-
sudo mv clickup /usr/local/bin/
334-
- name: Authenticate
335-
run: echo "${{ secrets.CLICKUP_TOKEN }}" | clickup auth login --with-token
336-
- name: Post CI result
337-
run: |
338-
STATUS="${{ github.event.check_suite.conclusion }}"
339-
clickup comment add "" "CI ${STATUS}: ${{ github.event.check_suite.head_branch }} (${{ github.sha }})"
340-
```
341-
342-
## Releasing
343-
344-
Releases are handled automatically by GitHub Actions using [goreleaser](https://goreleaser.com/). To create a new release:
345-
346-
```sh
347-
git tag v0.x.y
348-
git push origin main --tags
349111
```
350112

351-
The workflow builds binaries for all platforms, creates a GitHub release, and updates the Homebrew tap. **Do not run `goreleaser` locally** — it will conflict with the CI release.
113+
Then `task view`, `task edit`, `status set`, `link pr`, and other commands automatically target the correct task. See the [git integration guide](https://triptechtravel.github.io/clickup-cli/git-integration/) for details.
352114

353115
## Documentation
354116

355-
Full documentation is available at [triptechtravel.github.io/clickup-cli](https://triptechtravel.github.io/clickup-cli/).
117+
Full documentation -- including [configuration](https://triptechtravel.github.io/clickup-cli/configuration/), [CI usage](https://triptechtravel.github.io/clickup-cli/ci-usage/), [GitHub Actions](https://triptechtravel.github.io/clickup-cli/github-actions/), [AI agent integration](https://triptechtravel.github.io/clickup-cli/ai-agents/), and [auto-generated command reference](https://triptechtravel.github.io/clickup-cli/reference/clickup/) -- is available at **[triptechtravel.github.io/clickup-cli](https://triptechtravel.github.io/clickup-cli/)**.
356118

357119
## Author
358120

0 commit comments

Comments
 (0)