You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
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.
179
104
180
105
## Git integration
181
106
182
-
The CLI auto-detects ClickUp task IDs from your current git branch name. Two patterns are recognized:
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:
190
108
191
109
```sh
192
110
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.
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
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
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
349
111
```
350
112
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.
352
114
353
115
## Documentation
354
116
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/)**.
0 commit comments