discountry ClickUp
Use the global clickup CLI. See README.md for installation, configuration, and command reference.
Rules
- Do not read
.envor secrets. - Read shell environment variables.
- Use
--jsonfor structured output. - Read current state before writes unless the requested change is already exact.
Checks
- Run
clickup --help. - On missing CLI, auth, or workspace errors, point to
README.md.
Commands
| Intent | Command |
|---|---|
| Read task | clickup get <url-or-id> |
| Read comments | clickup comments <url-or-id> |
| Add comment | clickup comment <url-or-id> "message" |
| Read or update status | clickup status <url-or-id> [status] |
| List tasks in list | clickup tasks <list_id> |
| Show current user | clickup me |
| Create task | clickup create [list_id] "title" |
| List my tasks | clickup my-tasks |
| Search tasks | clickup search "query" |
| Assign task | clickup assign <task> <user> |
| Set due date | clickup due <task> "date" |
| Set priority | clickup priority <task> <level> |
| Create subtask | clickup subtask <task> "title" |
| Move task | clickup move <task> <list_id> |
| Add link | clickup link <task> <url> ["description"] |
| Add checklist item | clickup checklist <task> "item" |
| Delete comment | clickup delete-comment <comment_id> |
| Notify watcher | clickup watch <task> <user> |
| Add tag | clickup tag <task> "tag_name" |
| Update description | clickup description <task> "text" |
| List docs | clickup docs ["query"] |
| Read doc | clickup doc <doc_id> |
| Create doc | clickup create-doc "title" [--content "..."] |
| Read page | clickup page <doc_id> <page_id> [--content-format text/plain] |
| Create page | clickup create-page <doc_id> "title" [--content "..."] [--sub-title "..."] |
| Update page | clickup edit-page <doc_id> <page_id> [--name "..."] [--sub-title "..."] [--content "..."] |
Execution
- Normalize the target.
- Read with the narrowest command.
- Apply the smallest write.
- Re-read only when the user needs confirmation.
Notes
clickup status <task>lists valid statuses.- Status updates allow partial matching.
assignandwatchresolve username, email, or user ID.clickup due <task> clearandclickup due <task> noneclear due dates.clickup docs ["query"]also supports--id,--creator,--deleted,--archived,--parent-id,--parent-type,--limit.clickup doc <doc_id>supports--max-page-depth.clickup create-page <doc_id> "title"supports--parent-page-id,--sub-title,--content-format.clickup edit-page <doc_id> <page_id>requires--name,--sub-title, or--content. It also supports--content-edit-modeand--content-format.watchposts an@mentioncomment.
URL Structure
Use correct ClickUp URL formats:
- Task:
https://app.clickup.com/t/{task_id} - Doc:
https://app.clickup.com/{workspace_id}/v/dc/{doc_id}/{page_id}
Document Creation Best Practices
When creating ClickUp docs:
- Set both doc title (via
create-doc "title") and page name (viaedit-page --name "page title"), never leave page name null. - Always use
--content-format text/mdfor markdown content; otherwise markdown syntax may be escaped. - Do not repeat the document title inside page content—the title is separate metadata.
- Verify Doc URLs contain all three IDs: workspace, doc, and page.