Skip to content

Latest commit

 

History

History
201 lines (165 loc) · 12.7 KB

File metadata and controls

201 lines (165 loc) · 12.7 KB

API Coverage

Status: ✅ implemented | 🚧 planned | 🚫 won't add

Tasks

Feature Command Status
List my tasks cup tasks
Get task details cup task <id>
Create task cup create
Update task cup update <id>
Delete task cup delete <id>
Search tasks cup search <query>
Open in browser cup open <query>
List subtasks cup subtasks <id>
Assign / unassign cup assign <id>
Duplicate task cup duplicate <id>
Create from template cup create --template
Bulk operations cup bulk <status|assign|due-date|tag|priority|field|move>

Dependencies & Relations

Feature Command Status
Add dependency cup depend <id>
Remove dependency cup depend <id> --remove
Add/remove task link cup link <id> <linksTo>

Multi-list

Feature Command Status
Add task to list cup move <id> --to
Remove from list cup move <id> --remove
Move to home list cup move --to ... --remove ...

Sprints & Planning

Feature Command Status
Active sprint tasks cup sprint [--folder]
List all sprints cup sprints
Assigned tasks by status cup assigned
Standup summary cup summary
Overdue tasks cup overdue
Recently updated cup inbox

Comments

Feature Command Status
List comments cup comments <id>
Post comment cup comment <id>
Edit comment cup comment-edit <id>
Task + comments combined cup activity <id>
Delete comment cup comment-delete <id>
Threaded replies cup replies <id> / cup reply <id>

Checklists

Feature Command Status
View checklists cup checklist view <id>
Create checklist cup checklist create <id> <name>
Delete checklist cup checklist delete <id>
Add item cup checklist add-item <id> <name>
Edit item cup checklist edit-item <id> <itemId>
Delete item cup checklist delete-item <id> <itemId>

Custom Fields

Feature Command Status
Set field value cup field <id> --set
Remove field value cup field <id> --remove
List available fields cup fields <listId>
Create custom field cup field-create <name>

Tags

Feature Command Status
Add/remove tag on task cup tag <id>
List space tags cup tags <spaceId>
Create space tag cup tag-create <spaceId> <name>
Update space tag cup tag-update <spaceId> <name>
Delete space tag cup tag-delete <spaceId> <name>

Time Tracking

Feature Command Status
Start timer cup time start <id>
Stop timer cup time stop
Timer status cup time status
Log time entry cup time log <id> <duration>
List entries cup time list
Update entry cup time update <id>
Delete entry cup time delete <id>

Workspace

Feature Command Status
List spaces cup spaces
Create space cup space-create <name>
Rename space cup space-rename <spaceId> <n>
List lists cup lists <spaceId>
Create list cup list-create <spaceId> <name>
Rename list cup list-rename <listId> <n>
List folders cup folders <spaceId>
Create folder cup folder-create <spaceId> <n>
Rename folder cup folder-rename <folderId> <n>
Check auth cup auth
List members cup members
Task types cup task-types
Task templates cup templates
List templates cup list-templates
Folder tmpl. cup folder-templates
Create from tpl cup list-from-template <name>

Views

Feature Command Status
List views cup views <listId>
Get view cup view <viewId>
Create view cup view-create <listId> <name>
Update view cup view-update <viewId>
Delete view cup view-delete <viewId>

Goals & Key Results

Feature Command Status
List goals cup goals
Create goal cup goal-create <name>
Update goal cup goal-update <goalId>
Delete goal cup goal-delete <goalId>
List key results cup key-results <goalId>
Create key result cup key-result-create <goalId> <n>
Update key result cup key-result-update <krId>
Delete key result cup key-result-delete <krId>

Docs

Feature Command Status
Search docs cup docs [query]
View doc / page cup doc <docId> [pageId]
All page content cup doc-pages <docId>
Create doc cup doc-create <title>
Create page cup doc-page-create <docId> <name>
Edit page cup doc-page-edit <docId> <pageId>
Delete doc cup doc-delete <docId>
Delete page cup doc-page-delete <docId> <pId>

Attachments

Feature Command Status
Upload file cup attach <id> <file>
List attachments shown inline in cup task
Delete attachment 🚫 No API endpoint

Setup

Feature Command Status
First-time setup cup init
Get/set config cup config
Shell completions cup completion <shell>

Won't add

Feature Why
Webhooks Server-side. A CLI can't listen for events.
OAuth flow cup init already handles auth with API tokens.
Guest/ACL Enterprise admin. Not what you reach for in a terminal.
Chat/DM Use the ClickUp app. Chat doesn't belong in a CLI.
Audit logs Enterprise admin.
User/group management Too destructive for a CLI - removing someone from a workspace is permanent.
List/Folder/Space U+D Update/delete structural items in the UI. Create is supported.
View/List/Chat comments API only supports task-level comments.
User Groups Enterprise admin feature.
Shared Hierarchy Enterprise admin feature.

API Limitations

These features exist in the ClickUp UI but aren't possible through the API:

Feature Limitation
Comment attachments API only supports task-level attachments (cup attach), not files within comments
@mention individual users API provides --notify-all but no way to target specific users via @syntax
Comment reactions No API endpoint for adding or viewing reactions
ClickUp Brain / AI No public API
In-comment checklists Only task-level checklists are supported via API
Voice notes / Video Recording is a UI-only feature