clickup
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseClickUp
ClickUp
Interact with ClickUp tasks and documents via the API. Get task information, view comments, create tasks, manage assignments, post updates, and create/edit documents.
通过API与ClickUp任务和文档进行交互。获取任务信息、查看评论、创建任务、管理分配、发布更新以及创建/编辑文档。
Setup
设置步骤
- Copy to
.env-examplein this skill directory.env - Add your ClickUp Personal API Token (starts with )
pk_ - Generate token at: ClickUp Settings > Apps > API Token
bash
cp .claude/skills/clickup/.env-example .claude/skills/clickup/.env- 将此技能目录下的复制为
.env-example.env - 添加你的ClickUp个人API令牌(以开头)
pk_ - 在以下位置生成令牌:ClickUp设置 > 应用 > API令牌
bash
cp .claude/skills/clickup/.env-example .claude/skills/clickup/.envEdit .env and add your token
编辑.env并添加你的令牌
Team ID and User ID are auto-detected and cached on first use.
团队ID和用户ID会在首次使用时自动检测并缓存。Default List (Optional)
默认列表(可选)
Set in to enable creating tasks without specifying a list:
CLICKUP_DEFAULT_LIST_ID.envbash
undefined在中设置,即可无需指定列表直接创建任务:
.envCLICKUP_DEFAULT_LIST_IDbash
undefinedIn .claude/skills/clickup/.env
在.claude/skills/clickup/.env中
CLICKUP_DEFAULT_LIST_ID=901111220963
undefinedCLICKUP_DEFAULT_LIST_ID=901111220963
undefinedRunning Commands
运行命令
bash
node .claude/skills/clickup/query.mjs <command> [options]bash
node .claude/skills/clickup/query.mjs <command> [options]Task Commands
任务命令
| Command | Description |
|---|---|
| Get task details (name, description, status, assignees, etc.) |
| List comments on a task |
| Post a comment to a task (supports markdown) |
| Update task status (or list available statuses) |
| List tasks in a list |
| Show current user info |
| Create a new task (list_id optional if default set) |
| List all tasks assigned to you across workspace |
| Search tasks by name or description |
| Assign task to a user (by name, email, or ID) |
| Set due date (e.g., "tomorrow", "friday", "+3d") |
| Set priority (urgent, high, normal, low, none) |
| Create a subtask |
| Move task to a different list |
| Add external link reference (as comment) |
| Add checklist item to task |
| Delete a comment |
| Notify user via @mention comment (watchers not supported in API) |
| Add a tag to task |
| Update task description (markdown supported) |
| 命令 | 描述 |
|---|---|
| 获取任务详情(名称、描述、状态、经办人等) |
| 列出任务的评论 |
| 向任务发布评论(支持markdown) |
| 更新任务状态(或列出可用状态) |
| 列出列表中的任务 |
| 显示当前用户信息 |
| 创建新任务(若设置了默认列表,则list_id可选) |
| 列出工作区中分配给你的所有任务 |
| 按名称或描述搜索任务 |
| 将任务分配给用户(按名称、邮箱或ID) |
| 设置截止日期(例如:"tomorrow"、"friday"、"+3d") |
| 设置优先级(urgent、high、normal、low、none) |
| 创建子任务 |
| 将任务移动到其他列表 |
| 添加外部链接引用(作为评论) |
| 向任务添加检查项 |
| 删除评论 |
| 通过@提及评论通知用户(API不支持关注者功能) |
| 向任务添加标签 |
| 更新任务描述(支持markdown) |
Document Commands
文档命令
| Command | Description |
|---|---|
| Search/list docs in workspace (optional search query) |
| Get doc details and page listing |
| Create a new doc (use |
| Get page content (markdown format) |
| Add a new page to a doc (creates additional page) |
| Edit a page's content or name |
| 命令 | 描述 |
|---|---|
| 搜索/列出工作区中的文档(可选搜索关键词) |
| 获取文档详情和页面列表 |
| 创建新文档(使用 |
| 获取页面内容(markdown格式) |
| 向文档添加新页面(创建额外页面) |
| 编辑页面内容或名称 |
Options
选项
| Flag | Description |
|---|---|
| Output raw JSON response |
| Include subtasks when getting task details |
| Filter to tasks assigned to me (for tasks command) |
| Page content for create-page/edit-page (markdown) |
| New page name for edit-page |
| 标识 | 描述 |
|---|---|
| 输出原始JSON响应 |
| 获取任务详情时包含子任务 |
| 筛选分配给我的任务(针对tasks命令) |
| 用于create-page/edit-page的页面内容(markdown格式) |
| 用于edit-page的新页面名称 |
Examples
示例
Get Task Details
获取任务详情
bash
undefinedbash
undefinedUsing full URL
使用完整URL
node .claude/skills/clickup/query.mjs get "https://app.clickup.com/t/86a1b2c3d"
node .claude/skills/clickup/query.mjs get "https://app.clickup.com/t/86a1b2c3d"
Using task ID directly
直接使用任务ID
node .claude/skills/clickup/query.mjs get 86a1b2c3d
node .claude/skills/clickup/query.mjs get 86a1b2c3d
Include subtasks
包含子任务
node .claude/skills/clickup/query.mjs get 86a1b2c3d --subtasks
undefinednode .claude/skills/clickup/query.mjs get 86a1b2c3d --subtasks
undefinedCreate a Task
创建任务
bash
undefinedbash
undefinedWith explicit list ID
指定列表ID
node .claude/skills/clickup/query.mjs create 901111220963 "New feature: dark mode"
node .claude/skills/clickup/query.mjs create 901111220963 "新功能:深色模式"
Using default list (if CLICKUP_DEFAULT_LIST_ID is set)
使用默认列表(若已设置CLICKUP_DEFAULT_LIST_ID)
node .claude/skills/clickup/query.mjs create "Quick task"
undefinednode .claude/skills/clickup/query.mjs create "快速任务"
undefinedList My Tasks
列出我的任务
bash
undefinedbash
undefinedAll tasks assigned to you across the workspace
工作区中分配给你的所有任务
node .claude/skills/clickup/query.mjs my-tasks
undefinednode .claude/skills/clickup/query.mjs my-tasks
undefinedSearch Tasks
搜索任务
bash
node .claude/skills/clickup/query.mjs search "authentication"bash
node .claude/skills/clickup/query.mjs search "authentication"Update Task Status
更新任务状态
bash
undefinedbash
undefinedList available statuses for a task
列出任务的可用状态
node .claude/skills/clickup/query.mjs status 86a1b2c3d
node .claude/skills/clickup/query.mjs status 86a1b2c3d
Update status (case-insensitive, partial match)
更新状态(不区分大小写,支持部分匹配)
node .claude/skills/clickup/query.mjs status 86a1b2c3d "in progress"
node .claude/skills/clickup/query.mjs status 86a1b2c3d "complete"
undefinednode .claude/skills/clickup/query.mjs status 86a1b2c3d "in progress"
node .claude/skills/clickup/query.mjs status 86a1b2c3d "complete"
undefinedAssign Tasks
分配任务
bash
undefinedbash
undefinedAssign by username
按用户名分配
node .claude/skills/clickup/query.mjs assign 86a1b2c3d justin
node .claude/skills/clickup/query.mjs assign 86a1b2c3d justin
Assign by email
按邮箱分配
node .claude/skills/clickup/query.mjs assign 86a1b2c3d jane@example.com
undefinednode .claude/skills/clickup/query.mjs assign 86a1b2c3d jane@example.com
undefinedSet Due Dates
设置截止日期
bash
node .claude/skills/clickup/query.mjs due 86a1b2c3d "tomorrow"
node .claude/skills/clickup/query.mjs due 86a1b2c3d "next friday"
node .claude/skills/clickup/query.mjs due 86a1b2c3d "+3d"
node .claude/skills/clickup/query.mjs due 86a1b2c3d "2024-01-15"bash
node .claude/skills/clickup/query.mjs due 86a1b2c3d "tomorrow"
node .claude/skills/clickup/query.mjs due 86a1b2c3d "next friday"
node .claude/skills/clickup/query.mjs due 86a1b2c3d "+3d"
node .claude/skills/clickup/query.mjs due 86a1b2c3d "2024-01-15"Set Priority
设置优先级
bash
node .claude/skills/clickup/query.mjs priority 86a1b2c3d urgent
node .claude/skills/clickup/query.mjs priority 86a1b2c3d high
node .claude/skills/clickup/query.mjs priority 86a1b2c3d none # Clear prioritybash
node .claude/skills/clickup/query.mjs priority 86a1b2c3d urgent
node .claude/skills/clickup/query.mjs priority 86a1b2c3d high
node .claude/skills/clickup/query.mjs priority 86a1b2c3d none # 清除优先级Create Subtasks
创建子任务
bash
node .claude/skills/clickup/query.mjs subtask 86a1b2c3d "Write unit tests"
node .claude/skills/clickup/query.mjs subtask 86a1b2c3d "Update documentation"bash
node .claude/skills/clickup/query.mjs subtask 86a1b2c3d "编写单元测试"
node .claude/skills/clickup/query.mjs subtask 86a1b2c3d "更新文档"Move Tasks
移动任务
bash
node .claude/skills/clickup/query.mjs move 86a1b2c3d 901111220964bash
node .claude/skills/clickup/query.mjs move 86a1b2c3d 901111220964Add Links
添加链接
bash
undefinedbash
undefinedAdd link with description
添加带描述的链接
node .claude/skills/clickup/query.mjs link 86a1b2c3d "https://github.com/..." "PR #123"
node .claude/skills/clickup/query.mjs link 86a1b2c3d "https://github.com/..." "PR #123"
Add link without description
添加不带描述的链接
node .claude/skills/clickup/query.mjs link 86a1b2c3d "https://docs.example.com/guide"
undefinednode .claude/skills/clickup/query.mjs link 86a1b2c3d "https://docs.example.com/guide"
undefinedAdd Checklist Items
添加检查项
bash
node .claude/skills/clickup/query.mjs checklist 86a1b2c3d "Review code"
node .claude/skills/clickup/query.mjs checklist 86a1b2c3d "Run tests"
node .claude/skills/clickup/query.mjs checklist 86a1b2c3d "Deploy to staging"bash
node .claude/skills/clickup/query.mjs checklist 86a1b2c3d "审核代码"
node .claude/skills/clickup/query.mjs checklist 86a1b2c3d "运行测试"
node .claude/skills/clickup/query.mjs checklist 86a1b2c3d "部署到预发布环境"List Tasks in a List
列出列表中的任务
bash
undefinedbash
undefinedAll tasks in a list
列表中的所有任务
node .claude/skills/clickup/query.mjs tasks 901111220963
node .claude/skills/clickup/query.mjs tasks 901111220963
Only tasks assigned to me
仅列出分配给我的任务
node .claude/skills/clickup/query.mjs tasks 901111220963 --me
undefinednode .claude/skills/clickup/query.mjs tasks 901111220963 --me
undefinedView Comments
查看评论
bash
node .claude/skills/clickup/query.mjs comments "https://app.clickup.com/t/86a1b2c3d"bash
node .claude/skills/clickup/query.mjs comments "https://app.clickup.com/t/86a1b2c3d"Post a Comment
发布评论
bash
node .claude/skills/clickup/query.mjs comment 86a1b2c3d "Starting work on this task"bash
node .claude/skills/clickup/query.mjs comment 86a1b2c3d "开始处理此任务"Multi-line comment
多行评论
node .claude/skills/clickup/query.mjs comment 86a1b2c3d "Status update:
- Completed initial review
- Found 3 issues to address
- Will submit PR by EOD"
undefinednode .claude/skills/clickup/query.mjs comment 86a1b2c3d "状态更新:
- 完成初步审核
- 发现3个需要解决的问题
- 将在今日下班前提交PR"
undefinedShow Current User
显示当前用户
bash
node .claude/skills/clickup/query.mjs mebash
node .claude/skills/clickup/query.mjs meDelete a Comment
删除评论
bash
undefinedbash
undefinedGet comment IDs from the comments command (shown in --json output)
从comments命令获取评论ID(在--json输出中显示)
node .claude/skills/clickup/query.mjs delete-comment 90110200841741
undefinednode .claude/skills/clickup/query.mjs delete-comment 90110200841741
undefinedNotify Users (Watch)
通知用户(关注)
bash
undefinedbash
undefinedNotify user via @mention comment (ClickUp API doesn't support adding watchers directly)
通过@提及评论通知用户(ClickUp API不直接支持添加关注者)
node .claude/skills/clickup/query.mjs watch 86a1b2c3d koen
node .claude/skills/clickup/query.mjs watch 86a1b2c3d koen
Notify by email
通过邮箱通知
node .claude/skills/clickup/query.mjs watch 86a1b2c3d jane@example.com
undefinednode .claude/skills/clickup/query.mjs watch 86a1b2c3d jane@example.com
undefinedAdd Tags
添加标签
bash
undefinedbash
undefinedAdd a tag to a task
向任务添加标签
node .claude/skills/clickup/query.mjs tag 86a1b2c3d "DevOps"
node .claude/skills/clickup/query.mjs tag 86a1b2c3d "bug"
undefinednode .claude/skills/clickup/query.mjs tag 86a1b2c3d "DevOps"
node .claude/skills/clickup/query.mjs tag 86a1b2c3d "bug"
undefinedUpdate Description
更新描述
bash
undefinedbash
undefinedUpdate task description with markdown
使用markdown更新任务描述
node .claude/skills/clickup/query.mjs description 86a1b2c3d "## Summary
This is a bold statement.
- Item 1
- Item 2
See documentation for more info."
undefinednode .claude/skills/clickup/query.mjs description 86a1b2c3d "## 摘要
这是一个加粗的陈述。
- 项1
- 项2
查看文档了解更多信息。"
undefinedList/Search Docs
列出/搜索文档
bash
undefinedbash
undefinedList all docs in workspace
列出工作区中的所有文档
node .claude/skills/clickup/query.mjs docs
node .claude/skills/clickup/query.mjs docs
Search docs by name
按名称搜索文档
node .claude/skills/clickup/query.mjs docs "API"
undefinednode .claude/skills/clickup/query.mjs docs "API"
undefinedGet Doc Details
获取文档详情
bash
undefinedbash
undefinedGet doc info and page listing
获取文档信息和页面列表
node .claude/skills/clickup/query.mjs doc abc123def
node .claude/skills/clickup/query.mjs doc abc123def
Using a doc URL
使用文档URL
node .claude/skills/clickup/query.mjs doc "https://app.clickup.com/12345/v/dc/abc123def"
undefinednode .claude/skills/clickup/query.mjs doc "https://app.clickup.com/12345/v/dc/abc123def"
undefinedCreate a Doc
创建文档
bash
undefinedbash
undefinedCreate an empty doc
创建空文档
node .claude/skills/clickup/query.mjs create-doc "Project Notes"
node .claude/skills/clickup/query.mjs create-doc "项目笔记"
Create a doc with initial content (populates the first page)
创建带初始内容的文档(填充第一页)
node .claude/skills/clickup/query.mjs create-doc "API Documentation" --content "# API Documentation
This document covers the API endpoints and usage.
node .claude/skills/clickup/query.mjs create-doc "API文档" --content "# API文档
本文档涵盖API端点和使用方法。
Overview
概述
..."
undefined..."
undefinedGet Page Content
获取页面内容
bash
undefinedbash
undefinedGet a specific page's content
获取特定页面的内容
node .claude/skills/clickup/query.mjs page abc123def page456
undefinednode .claude/skills/clickup/query.mjs page abc123def page456
undefinedCreate a Page
创建页面
bash
undefinedbash
undefinedCreate a page with just a title
仅创建带标题的页面
node .claude/skills/clickup/query.mjs create-page abc123def "New Section"
node .claude/skills/clickup/query.mjs create-page abc123def "新章节"
Create a page with content
创建带内容的页面
node .claude/skills/clickup/query.mjs create-page abc123def "Getting Started" --content "# Welcome
This is the getting started guide.
node .claude/skills/clickup/query.mjs create-page abc123def "入门指南" --content "# 欢迎
这是入门指南。
Prerequisites
前提条件
- Node.js 18+
- npm or yarn"
undefined- Node.js 18+
- npm或yarn"
undefinedEdit a Page
编辑页面
bash
undefinedbash
undefinedUpdate page content
更新页面内容
node .claude/skills/clickup/query.mjs edit-page abc123def page456 --content "Updated content here"
node .claude/skills/clickup/query.mjs edit-page abc123def page456 --content "此处为更新后的内容"
Rename a page
重命名页面
node .claude/skills/clickup/query.mjs edit-page abc123def page456 --name "New Page Name"
node .claude/skills/clickup/query.mjs edit-page abc123def page456 --name "新页面名称"
Update both content and name
同时更新内容和名称
node .claude/skills/clickup/query.mjs edit-page abc123def page456 --content "New content" --name "New Name"
undefinednode .claude/skills/clickup/query.mjs edit-page abc123def page456 --content "新内容" --name "新名称"
undefinedTask/List/Doc URL Formats
任务/列表/文档URL格式
The skill recognizes these ClickUp URL formats:
Tasks:
https://app.clickup.com/t/{task_id}https://app.clickup.com/{team_id}/v/li/{list_id}?p={task_id}- Direct task ID:
86a1b2c3d
Lists:
https://app.clickup.com/{team_id}/v/li/{list_id}- Direct list ID:
901111220963
Docs:
https://app.clickup.com/{team_id}/v/dc/{doc_id}https://app.clickup.com/{team_id}/docs/{doc_id}- Direct doc ID:
abc123def
该技能支持以下ClickUp URL格式:
任务:
https://app.clickup.com/t/{task_id}https://app.clickup.com/{team_id}/v/li/{list_id}?p={task_id}- 直接任务ID:
86a1b2c3d
列表:
https://app.clickup.com/{team_id}/v/li/{list_id}- 直接列表ID:
901111220963
文档:
https://app.clickup.com/{team_id}/v/dc/{doc_id}https://app.clickup.com/{team_id}/docs/{doc_id}- 直接文档ID:
abc123def
Output Format
输出格式
Task Details
任务详情
Task: Implement user authentication
Status: In Progress
Priority: High
Assignees: John Doe, Jane Smith
Due: 2024-01-15
Created: 2024-01-10
URL: https://app.clickup.com/t/86a1b2c3d
Description:
Add OAuth2 authentication with Google and GitHub providers...任务:实现用户认证
状态:进行中
优先级:高
经办人:John Doe, Jane Smith
截止日期:2024-01-15
创建时间:2024-01-10
URL:https://app.clickup.com/t/86a1b2c3d
描述:
添加支持Google和GitHub提供商的OAuth2认证...Task List
任务列表
[to do] Fix login bug
ID: 868h2cxat | Priority: high | Assignees: John Doe
https://app.clickup.com/t/868h2cxat
[in progress] Update API docs
ID: 868g7c75u | Priority: None | Assignees: Jane Smith
https://app.clickup.com/t/868g7c75u
Total: 2 task(s)[待办] 修复登录bug
ID: 868h2cxat | 优先级:高 | 经办人:John Doe
https://app.clickup.com/t/868h2cxat
[进行中] 更新API文档
ID: 868g7c75u | 优先级:无 | 经办人:Jane Smith
https://app.clickup.com/t/868g7c75u
总计:2个任务Comments
评论
[2024-01-12 14:30] John Doe:
Started working on this. Will push initial commit today.
[2024-01-12 16:45] Jane Smith:
@John looks good! Let me know when ready for review.[2024-01-12 14:30] John Doe:
开始处理此任务。今日将推送初始提交。
[2024-01-12 16:45] Jane Smith:
@John 看起来不错!准备好审核时请告知我。Doc Details
文档详情
Doc: API Documentation
ID: abc123def
Created: Jan 10, 2024, 09:30 AM
Updated: Jan 15, 2024, 02:45 PM
Creator: John Doe
Workspace: 12345678
Pages:
Introduction
ID: page001
Getting Started
ID: page002
API Reference
ID: page003
Total: 3 page(s)文档:API文档
ID: abc123def
创建时间:2024年1月10日 09:30
更新时间:2024年1月15日 14:45
创建人:John Doe
工作区:12345678
页面:
简介
ID: page001
入门指南
ID: page002
API参考
ID: page003
总计:3个页面Page Content
页面内容
Page: Getting Started
ID: page002
Created: Jan 10, 2024, 10:00 AM
Updated: Jan 14, 2024, 03:30 PM
Content:
---页面:入门指南
ID: page002
创建时间:2024年1月10日 10:00
更新时间:2024年1月14日 15:30
内容:
---Getting Started
入门指南
Welcome to the API documentation.
欢迎查看API文档。
Prerequisites
前提条件
- Node.js 18+
- An API key
undefined- Node.js 18+
- API密钥
undefinedWhen to Use
使用场景
Tasks:
- Understanding context: Get task details before starting work
- Quick task creation: Create tasks without leaving your terminal
- Daily standups: Use to see your assignments
my-tasks - Status updates: Post progress comments as you work
- Task management: Assign, prioritize, and set due dates
- Collaboration: View recent comments for context, add watchers
- Task organization: Add tags to categorize tasks
- Task linking: Reference task IDs in commit messages
Documents:
- Documentation: Create and maintain project documentation
- Knowledge base: Build reference guides and wikis
- Meeting notes: Store meeting notes and decisions
- Specifications: Write and update technical specs
- Quick edits: Update doc content without leaving the terminal
任务:
- 了解上下文:开始工作前获取任务详情
- 快速创建任务:无需离开终端即可创建任务
- 每日站会:使用查看你的分配任务
my-tasks - 状态更新:工作时发布进度评论
- 任务管理:分配、设置优先级和截止日期
- 协作:查看最新评论了解上下文,添加关注者
- 任务组织:添加标签对任务进行分类
- 任务关联:在提交信息中引用任务ID
文档:
- 文档编制:创建和维护项目文档
- 知识库:构建参考指南和维基
- 会议记录:存储会议记录和决策
- 规格说明:编写和更新技术规格
- 快速编辑:无需离开终端即可更新文档内容
Tips
提示
- Team ID, User ID, and default list ID are auto-cached in
.env - Set to skip list_id when creating team tasks
CLICKUP_DEFAULT_LIST_ID - Use for a quick overview of your assignments
my-tasks - Use natural language dates: "tomorrow", "next friday", "+3d"
- Post comments to keep stakeholders updated on progress
- Include task IDs in commit messages for traceability
- Use for scripting or piping to other tools
--json - Doc content uses markdown format for both input and output
- The Docs API uses v3 endpoints (workspace-based instead of team-based)
- 团队ID、用户ID和默认列表ID会自动缓存在中
.env - 设置,创建团队任务时可跳过list_id
CLICKUP_DEFAULT_LIST_ID - 使用快速查看你的分配任务
my-tasks - 使用自然语言日期:"tomorrow"、"next friday"、"+3d"
- 发布评论让利益相关者了解进度
- 在提交信息中包含任务ID以实现可追溯性
- 使用用于脚本编写或管道到其他工具
--json - 文档内容的输入和输出均使用markdown格式
- 文档API使用v3端点(基于工作区而非团队)
Technical Notes
技术说明
Markdown Handling
Markdown处理
ClickUp uses different content formats for different features:
| Feature | API Version | Content Format |
|---|---|---|
| Comments | v2 | Proprietary JSON array (converted via |
| Task descriptions | v2 | Native markdown via |
| Docs/Pages | v3 | Native markdown (no conversion needed) |
The Docs API (v3) accepts and returns markdown directly, so no conversion is required. This is different from comments which use a proprietary format that requires the conversion utilities.
lib/markdown.mjsClickUp针对不同功能使用不同的内容格式:
| 功能 | API版本 | 内容格式 |
|---|---|---|
| 评论 | v2 | 专有JSON数组(通过 |
| 任务描述 | v2 | 通过 |
| 文档/页面 | v3 | 原生markdown(无需转换) |
文档API(v3)直接接受和返回markdown,因此无需转换。这与评论不同,评论使用专有格式,需要转换工具。
lib/markdown.mjsDoc Page Structure
文档页面结构
When you create a doc via the API, ClickUp automatically creates an empty first page. This has implications:
- - Creates a doc with an auto-generated first page. Use
create-docto populate that first page.--content - - Adds an additional page to a doc (second page, third page, etc.)
create-page - - Modifies an existing page's content
edit-page
To add content to a new doc, use rather than creating the doc and then using (which would leave the first page empty).
create-doc "Title" --content "..."create-page通过API创建文档时,ClickUp会自动创建一个空的第一页。这会产生以下影响:
- - 创建带自动生成第一页的文档。使用
create-doc填充该第一页。--content - - 向文档添加额外页面(第二页、第三页等)
create-page - - 修改现有页面的内容
edit-page
要向新文档添加内容,请使用,而不是先创建文档再使用(这会导致第一页为空)。
create-doc "标题" --content "..."create-page