clickup について
API 経由で ClickUp のタスク、コメント、リスト、ドキュメントを操作するコマンドラインスキルです。タスク管理を行うエージェントや自動化向けで、複数の名前付きアカウントを扱えます。
主な機能
- 01タスクの閲覧と検索
- 02タスクの作成と更新
- 03コメントと担当者の管理
- 04ドキュメントの作成と編集
- 05複数の名前付きアカウント
活用シーン
- 01タスクとスレッドコメントの確認
- 02担当者と期限を指定したタスク作成
- 03ステータス、優先度、依存関係の更新
- 04範囲を指定したワークスペース内検索
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ civitai/ civitai --skill clickupインストール後、Claude Code で/clickupを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
.env.example.gitignoreaccounts.json.examplelisten.mjspackage-lock.jsonpackage.jsonquery.mjsreference.mdwatch.mjsapi/attachments.mjschecklists.mjsclient.mjscomments.mjsdocs.mjslinks.mjslists.mjsspaces.mjstasks.mjsuser.mjswebhooks.mjslib/accounts.mjsbatch-create.mjsbulk.mjsformat.mjsmarkdown.mjsmentions.mjsparse.mjstest/leak-check.mjssmoke-test.mjs詳細
ClickUp
API を使用して ClickUp のタスクやドキュメントを操作します。タスク情報の取得、コメントの表示、タスクの作成、担当者の管理、更新の投稿、ドキュメントの作成・編集ができます。
タスクを作成する前に、docs/dev/filing-follow-ups.md をお読みください。 すべてのタスクに完了条件が必要です。また、エージェントが生成したフォローアップは Synced Team ではなく Agent Follow-ups に登録してください。
セットアップ
最初に依存関係をインストールしてください(チェックアウトごとに一度)。
cd .claude/skills/clickup && npm install
lib/markdown.mjs は remark を使用して Markdown を解析し、query.mjs は起動時に lib/format.mjs を介してこれを呼び出します。これを実行するまでは、コメント関連のコマンドだけでなく、すべてのコマンドが ERR_MODULE_NOT_FOUND で終了します。
次に、このスキルのディレクトリに API トークンを記述した accounts.json を作成します。
{
"defaultAccount": "bot",
"accounts": {
"bot": {
"apiToken": "pk_your_token_here"
}
}
}
トークンは ClickUp の Settings > Apps > API Token で生成してください。
または、CLI を使用してアカウントを追加できます。
node query.mjs add-account bot --token pk_your_token_here
Team ID、User ID などのフィールドは、初回使用時に自動検出され、キャッシュされます。
.env からの移行:既存の .env ファイルがある場合、初回実行時に認証情報が accounts.json に自動移行されます。.env ファイルは保持されるため、不要になった時点で削除してください。
デフォルトのリスト(任意)
アカウントで defaultListId を設定すると、リストを指定せずにタスクを作成できます。
{
"defaultAccount": "bot",
"accounts": {
"bot": {
"apiToken": "pk_...",
"defaultListId": "901111220963"
}
}
}
複数アカウント
名前付きの複数アカウント(例:自動化用の「bot」、個人使用の「jane」)をサポートしています。
{
"defaultAccount": "bot",
"accounts": {
"bot": {
"apiToken": "pk_...",
"teamId": "8459928",
"userId": "75386805",
"defaultListId": "901111220963"
},
"jane": {
"apiToken": "pk_...",
"teamId": "8459928",
"userId": "12345678"
}
}
}
各アカウントで必要なのは apiToken のみです。その他のフィールドは自動検出され、キャッシュされます。
任意のコマンドで --account <name> を使用すると、対象のアカウントを指定できます。
node query.mjs me --account jane
node query.mjs my-tasks --account bot
アカウント管理コマンド:
node query.mjs accounts # List all accounts
node query.mjs switch-account jane # Change default
node query.mjs add-account jane --token pk_... # Add account
node query.mjs remove-account old-account # Remove account
コマンドの実行
node query.mjs <command> [options]
タスクコマンド
| コマンド | 説明 |
|---|---|
get <url|id> | タスクの詳細(名前、説明、ステータス、担当者など)を取得します |
comments <url|id> | タスクのコメントを一覧表示します(--threads を使うと返信をインラインで展開します) |
thread <comment_id> | 特定のコメントへのスレッド形式の返信を表示します |
reply <comment_id> "message" | コメントにスレッド形式の返信を投稿します |
comment <url|id> "message" | タスクにコメントを投稿します(Markdown に対応) |
status <url|id> [status] | タスクのステータスを更新します(または利用可能なステータスを一覧表示します) |
tasks <list_id> | リスト内のタスクを一覧表示します |
me | 現在のユーザー情報を表示します |
create [list_id] "title" | 新しいタスクを作成します(デフォルトが設定されている場合、list_id は省略可能です) |
my-tasks | ワークスペース全体で自分に割り当てられたすべてのタスクを一覧表示します |
search [query] | タスクを検索します — スコープの指定が必要です:--list、--folder、--me、--assignee、--status、または --all |
find-list "name" | 名前でリストまたはフォルダーを検索します(タスクを取得せず、構造をすばやく走査します) |
assign <task> <user> | タスクをユーザーに割り当てます(名前、メールアドレス、または ID で指定) |
due <task> "date" | 期限を設定します(例:「tomorrow」、「friday」、「+3d」) |
priority <task> <level> | 優先度を設定します(urgent、high、normal、low、none) |
subtask <task> "title" | サブタスクを作成します |
parent <task> <parent_task> | 既存のタスクを別のタスクのサブタスクにします |
milestone <task> <on|off> | タスクをマイルストーンにする、または通常のタスクに戻します |
move <task> <list_id> | タスクを別のリストに移動します |
link <task> <url> ["desc"] | 外部リンクの参照を追加します(コメントとして) |
checklist <task> "item" | タスクにチェックリスト項目を追加します |
delete-comment <comment_id> | コメントを削除します |
watch <task> <user> | タスクのウォッチャー/フォロワーとしてユーザーを追加します |
tag <task> "tag_name" | タスクにタグを追加します |
description <task> "text" | タスクの説明を更新します(Markdown に対応) |
start <task> "date" | 開始日を設定します(期限と同じ日付形式を使用します) |
schedule <task> "start" "due" | 開始日と期限の両方を設定します |
rename <task> "new name" | タスク名を変更します |
depends <task> <other> | タスクを別のタスクの完了待ちに設定します |
blocks <task> <other> | タスクが別のタスクを妨げていることを設定します |
task-link <task> <other> | タスク間に双方向リンクを作成します |
update-comment <id> "text" | コメントのテキストを更新します |
resolve-comment <id> | コメントを解決済み/クローズ済みにします |
remove-tag <task> "tag" | タスクからタグを削除します |
unwatch <task> <user> | タスクからウォッチャーを削除します |
archive <task> | タスクをアーカイブします(アクティブビューから削除します) |
unarchive <task> | アーカイブ済みのタスクを復元します |
claim <task> | セッションをこのタスクにリンクします(再開できるように、Session ID のカスタムフィールドを設定します) |
リストコマンド
| コマンド | 説明 |
|---|---|
list <list_id> | リストの詳細(名前、ステータス、タスク数)を取得します |
create-list <space> "name" | スペースに新しいリストを作成します |
update-list <list_id> | リストのプロパティを更新します(--name、--content) |
delete-list <list_id> | リストを削除します |
lists <folder_id> | フォルダー内のすべてのリストを一覧表示します |
space-lists <space_id> | スペース内のフォルダーに属さないリストを一覧表示します |
ドキュメントコマンド
| コマンド | 説明 |
|---|---|
docs ["query"] | ワークスペース内のドキュメントを検索/一覧表示します(検索クエリは省略可能です) |
doc <doc_id> | ドキュメントの詳細とページ一覧を取得します |
create-doc "title" | 新しいドキュメントを作成します(初期コンテンツには --content を使用します) |
page <doc_id> <page_id> | ページの内容を取得します(Markdown 形式) |
create-page <doc_id> "title" | ドキュメントに新しいページを追加します(サブページには --parent を使用します) |
edit-page <doc_id> <page_id> | ページの内容または名前を編集します |
添付ファイルコマンド
| コマンド | 説明 |
|---|---|
attach <url|id> | ファイルの添付ファイルをタスクにアップロードします(--attach path を指定します。複数回指定できます) |
fetch-image <url> | ClickUp の添付ファイルをローカルの一時ファイルにダウンロードします(保存先を指定するには --output path を使用します) |
オプション
| フラグ | 説明 |
|---|---|
--json | 生の JSON レスポンスを出力します |
--threads, -t | コメントの一覧表示時に、スレッド形式の返信をインラインで展開します |
--subtasks | タスクの詳細取得時にサブタスクを含めます |
--me | 自分に割り当てられたタスクに絞り込みます(tasks コマンド用) |
--content, -c | インラインのコンテンツ文字列(Markdown)です。短いテキストにのみ使用してください。 |
--file, -f | ファイルパスからコンテンツを読み込みます。1 文を超える内容にはこちらを推奨します。 |
--cleanup | 実行が成功した後に --file を削除します |
--name, -n | edit-page 用の新しいページ名 |
--parent, -p | create-page 用の親ページ ID(サブページとして作成します) |
--space, -s | create-doc 用のスペース ID(ドキュメントをそのスペースに配置します) |
--assignee, -a | タスク作成時の担当者 |
--due, -d | タスク作成時の期限 |
--description, --desc | タスク作成時の説明(Markdown) |
--attach | 添付ファイルとしてアップロードするファイルパス(複数指定可。attach および comment コマンド用) |
--output | fetch-image 用のカスタム出力先パス(デフォルト:一時ディレクトリ) |
--account | 指定した名前付きアカウントを使用します(accounts.json から) |
使用例
タスクの詳細を取得する
# Using full URL
node query.mjs get "https://app.clickup.com/t/86a1b2c3d"
# Using task ID directly
node query.mjs get 86a1b2c3d
# Include subtasks
node query.mjs get 86a1b2c3d --subtasks
タスクを作成する
# With explicit list ID
node query.mjs create 901111220963 "New feature: dark mode"
# Using default list (if CLICKUP_DEFAULT_LIST_ID is set)
node query.mjs create "Quick task"
自分のタスクを一覧表示する
# All tasks assigned to you across the workspace
node query.mjs my-tasks
タスクを検索する
ClickUp の v2 API には、タスク全体を対象としたネイティブのテキスト検索機能がありません。そのため、search ではワークスペースのクロール範囲を限定するためのスコープが必要です。用途に合ったスコープを選択してください。
# Scope to a specific list (fastest, recommended)
node query.mjs search "authentication" --list 901111220963
# All tasks assigned to you with a particular status
node query.mjs search --me --status "in progress"
# Scope to a folder ("project") — scans every list in that folder
node query.mjs search "oauth" --folder 90111122009
# Filter by assignee + text
node query.mjs search "migration" --assignee jane
# Multiple statuses (comma-separated)
node query.mjs search --me --status "in progress,review"
# Unscoped full-workspace scan — slow, fetches every task. Use sparingly.
node query.mjs search "dark mode" --all
スコープを示すフラグを指定せず(かつ --all も指定せずに)実行すると、search は API に無制限にリクエストを送ることなく、わかりやすいエラーを表示して終了します。
名前でリストまたはフォルダーを検索する
リスト名(「Red Launch」、「Triage」、「Sprint 12」など)はわかっていても ID がわからない場合は、find-list を使用してください。メタデータ用エンドポイントのみを使って、ワークスペースの構造(スペース → フォルダー → リスト)をたどります。高速で、タスクの取得は行いません。
node query.mjs find-list "Red Launch"
node query.mjs find-list "triage" --json
一致結果は、完全一致 > 前方一致 > 部分一致の順に、大文字と小文字を区別せずに順位付けされます。リストの一致結果とフォルダーの一致結果(フォルダー内のリストもインラインで表示)を返すため、指定した名前がフォルダーの場合も、目的と思われるリストを確認できます。
タスクのステータスを更新する
# List available statuses for a task
node query.mjs status 86a1b2c3d
# Update status (case-insensitive, partial match)
node query.mjs status 86a1b2c3d "in progress"
node query.mjs status 86a1b2c3d "complete"
タスクを割り当てる
# Assign by username
node query.mjs assign 86a1b2c3d jane
# Assign by email
node query.mjs assign 86a1b2c3d [email protected]
期限を設定する
node query.mjs due 86a1b2c3d "tomorrow"
node query.mjs due 86a1b2c3d "next friday"
node query.mjs due 86a1b2c3d "+3d"
node query.mjs due 86a1b2c3d "2024-01-15"
優先度を設定する
node query.mjs priority 86a1b2c3d urgent
node query.mjs priority 86a1b2c3d high
node query.mjs priority 86a1b2c3d none # Clear priority
サブタスクを作成する
node query.mjs subtask 86a1b2c3d "Write unit tests"
node query.mjs subtask 86a1b2c3d "Update documentation"
既存のタスクの親を変更する
subtask は新しいタスクを作成します。parent は既存のタスクを指定し、別のタスクの配下に配置します。
node query.mjs parent 86a1b2c3d 86a9z8y7x # 86a1b2c3d becomes a subtask of 86a9z8y7x
タスク自身を親にすることや、タスクをその子孫の配下に移動することはできません。また、指定された親ではなく、実行後にサーバーから読み取った親を報告します。
使用する前に、次の 2 点を確認してください。
- 親から切り離すことはできません。 ClickUp の UpdateTask ドキュメントには、「
parentをnullに設定しても、サブタスクをタスクに変換することはできません」と記載されています。親の変更を元に戻すには ClickUp の UI が必要です。 - 別のリストにある親の配下へ移動すると、タスクは親のリストに移動します。 「Agent Follow-ups」のタスクを「Synced Team」にある親の配下へ移動すると、タスクは「Synced Team」に移動します。この場合、コマンドは
List moved: ... -> ...と出力します。
マイルストーン
node query.mjs milestone 86a1b2c3d on # mark as milestone
node query.mjs milestone 86a1b2c3d off # back to an ordinary task
マイルストーンはステータスではなく、タスクの種類です。種類 ID はワークスペースごとに異なるため、ハードコードせず、名前で解決します。親の変更とは異なり、この操作は元に戻せます。
モードの指定は必須です。on/off を指定せずに milestone <task> を実行するとエラーになります。コマンド名が質問のように見えるコマンドで、デフォルト値を設定すると書き込みが発生してしまうためです。
タスクを移動する
node query.mjs move 86a1b2c3d 901111220964
リンクを追加する
# Add link with description
node query.mjs link 86a1b2c3d "https://github.com/..." "PR #123"
# Add link without description
node query.mjs link 86a1b2c3d "https://docs.example.com/guide"
チェックリスト項目を追加する
node query.mjs checklist 86a1b2c3d "Review code"
node query.mjs checklist 86a1b2c3d "Run tests"
node query.mjs checklist 86a1b2c3d "Deploy to staging"
リスト内のタスクを一覧表示する
# All tasks in a list
node query.mjs tasks 901111220963
# Only tasks assigned to me
node query.mjs tasks 901111220963 --me
コメントを表示する
node query.mjs comments "https://app.clickup.com/t/86a1b2c3d"
# Expand all threaded replies inline
node query.mjs comments 86a1b2c3d --threads
# View replies on a specific comment thread
node query.mjs thread 90110200841741
# Reply to a comment thread
node query.mjs reply 90110200841741 "Sounds good, I'll take care of it."
コメントを投稿する
node query.mjs comment 86a1b2c3d "Starting work on this task"
# Multi-line comment
node query.mjs comment 86a1b2c3d "Status update:
- Completed initial review
- Found 3 issues to address
- Will submit PR by EOD"
コメント内でユーザーを @メンションする
このスキルは 2 つのメンション構文をサポートしています。
- 明示的 (推奨):
@[identifier]— 名前、メールアドレス、またはユーザー ID によるあいまい一致を伴うブラケット構文 - ベア (自動検出):
@Nameまたは@First Last— ワークスペースメンバーと自動的に突き合わせられます
ベアメンションはフォールバックであり、エージェントがブラケット構文を忘れてもメンションが機能するようにするためのものです。どちらも同じ ClickUp メンション属性を生成します。
# Explicit bracket syntax (preferred)
node query.mjs comment 86a1b2c3d "Hey @[jane], can you review this?"
# Bare mention (auto-detected against workspace members)
node query.mjs comment 86a1b2c3d "Hey @Jane Doe, can you review this?"
# Both work the same — these are equivalent:
node query.mjs comment 86a1b2c3d "@[jane] please review"
node query.mjs comment 86a1b2c3d "@Jane please review"
# Mention by numeric user ID (bracket syntax only)
node query.mjs comment 86a1b2c3d "@[12345678] please take a look"
# Mention by email (bracket syntax only)
node query.mjs comment 86a1b2c3d "Assigned to @[[email protected]]"
# Multiple mentions in one comment
node query.mjs comment 86a1b2c3d "@[jane] and @[john] - need your input on this"
**Bracket syntax**: Fuzzy matches partial names, emails, or numeric IDs. `@[jane]` matches "Jane Doe". Unknown users throw an error.
**Bare syntax**: Matches `@Name` against workspace member usernames (case-insensitive). Tries full name first (`@Jane Doe`), then first name (`@Jane`). Unmatched bare mentions are left as plain text (no error).
### Show Current User
```bash
node query.mjs me
コメントを削除する
# Get comment IDs from the comments command (shown in --json output)
node query.mjs delete-comment 90110200841741
ウォッチャーを追加/削除する
# Add user as watcher on a task
node query.mjs watch 86a1b2c3d john
# Remove watcher
node query.mjs unwatch 86a1b2c3d john
タグを追加する
# Add a tag to a task
node query.mjs tag 86a1b2c3d "DevOps"
node query.mjs tag 86a1b2c3d "bug"
説明を更新する
# Update task description with markdown
node query.mjs description 86a1b2c3d "## Summary
This is a **bold** statement.
- Item 1
- Item 2
See [documentation](https://example.com) for more info."
タスクをアーカイブ / 復元する
# Archive a task (removes from active views)
node query.mjs archive 86a1b2c3d
# Restore an archived task
node query.mjs unarchive 86a1b2c3d
タスクをクレームする (セッション連携)
ClickUp タスクの作業を開始したら、すぐにクレームしてください。そうすることで、後でセッションを再開できるようになります。これにより、Claude Code のセッション ID がタスクの「Session ID」カスタムフィールドに書き込まれ、作業を中断したところから再開できるようになります。
# Claim a task as soon as you begin working on it
node query.mjs claim 86a1b2c3d
# Works with URLs too
node query.mjs claim "https://app.clickup.com/t/86a1b2c3d"
要件:
- タスクのリストに、名前に「Session」を含むテキスト型カスタムフィールドが必要です (例: 「Session ID」)
- セッション ID の解決順序:
$CLAUDE_SESSION_ID→ 最も最近変更された~/.claude/projects/*/*.jsonl(60 秒以内)。このフォールバックは、環境変数を公開しないハーネスに対応します。
クレームするタイミング: ClickUp タスクの作業を開始したらすぐに。これは、後で同じタスクの作業を続ける必要が生じたときに、中断したところから再開するための方法です。
リストの詳細を取得する
# Get list info including statuses
node query.mjs list 901111220963
リストを作成する
# Create a list in a space using space ID
node query.mjs create-list 20128955 "New List"
# Create a list using space URL
node query.mjs create-list "https://app.clickup.com/8459928/v/s/20128955" "Sprint Backlog"
# Create a list with description
node query.mjs create-list 20128955 "Bug Tracker" --content "Track all bugs here"
リストを削除する
node query.mjs delete-list 901111220963
ドキュメントを一覧表示/検索する
# List all docs in workspace
node query.mjs docs
# Search docs by name
node query.mjs docs "API"
ドキュメントの詳細を取得する
# Get doc info and page listing
node query.mjs doc abc123def
# Using a doc URL
node query.mjs doc "https://app.clickup.com/12345/v/dc/abc123def"
ドキュメントを作成する
# Create an empty doc
node query.mjs create-doc "Project Notes"
# Create a doc with initial content (populates the first page)
node query.mjs create-doc "API Documentation" --content "# API Documentation
This document covers the API endpoints and usage.
## Overview
..."
ページの内容を取得する
# Get a specific page's content
node query.mjs page abc123def page456
ページを作成する
# Create a page with just a title
node query.mjs create-page abc123def "New Section"
# Create a page with content
node query.mjs create-page abc123def "Getting Started" --content "# Welcome
This is the getting started guide.
## Prerequisites
- Node.js 18+
- npm or yarn"
ページを編集する
# Update page content
node query.mjs edit-page abc123def page456 --content "Updated content here"
# Rename a page
node query.mjs edit-page abc123def page456 --name "New Page Name"
# Update both content and name
node query.mjs edit-page abc123def page456 --content "New content" --name "New Name"
添付ファイルをアップロードする
# Upload a single file to a task
node query.mjs attach 86a1b2c3d --attach ./screenshot.png
# Upload multiple files
node query.mjs attach 86a1b2c3d --attach ./screenshot1.png --attach ./report.pdf
# Post a comment with file attachments (comment first, then files are attached)
node query.mjs comment 86a1b2c3d "Here are the screenshots" --attach ./screenshot.png
# Comment with multiple attachments
node query.mjs comment 86a1b2c3d "Design review assets" --attach ./mockup.png --attach ./spec.pdf
サポートされるファイル形式: 画像 (PNG、JPG、GIF、WebP、SVG)、ドキュメント (PDF、DOCX、XLSX)、アーカイブ (ZIP)、および ClickUp が受け付けるその他のあらゆるファイル形式。
注: ClickUp API はファイルをタスク自体に添付します (タスクの添付ファイル一覧に表示されます)。comment コマンドで --attach を使用すると、まずコメントが投稿され、その後ファイルがタスクの添付ファイルとしてアップロードされます。ファイルはタスク内に表示されますが、コメント本文にインラインで埋め込まれるわけではありません。
コメント内の添付ファイルを表示する
画像やファイルの添付を含むコメントは、プレーンテキスト出力ではインラインで表示されます。
[Feb 11, 2026, 04:55 PM] Jane Doe (id: 90110200000001):
[Attachment: image.png](https://t8459928.p.clickup-attachments.com/...)
If you look at the component, you'll see that...
実際の画像を表示するには、fetch-image を使用してローカルにダウンロードします。
# Download attachment from URL shown in comment output
node query.mjs fetch-image "https://t8459928.p.clickup-attachments.com/t8459928/.../image.png"
# → Downloaded: /tmp/clickup-attachments/image.png
# Save to a specific path
node query.mjs fetch-image "https://..." --output ./screenshot.png
ダウンロード後、ファイルビューアーまたは Read ツールを使用して画像を表示します。
ファイルベースのコンテンツ (推奨)
1 文より長いコンテンツについては、まず markdown ファイルに書き込んでから、--content の代わりに --file を使用してください。これによりシェルのエスケープ問題を回避でき、適切な複数行の markdown をサポートできます。
ワークフロー
- コンテンツを一時的な markdown ファイルに書き込みます
--file path/to/file.mdで渡します- 任意で
--cleanupを追加すると、成功後にファイルが自動削除されます
例
# Create a doc from a prepared markdown file
node query.mjs create-doc "Architecture Spec" --file ./docs/spec.md --space 90114072520
# Update a page from a file, then auto-delete the temp file
node query.mjs edit-page abc123 page456 --file /tmp/updated-content.md --cleanup
# Post a detailed comment from a file
node query.mjs comment 86a1b2c3d --file ./review-notes.md
# Set task description from a file
node query.mjs description 86a1b2c3d --file ./task-brief.md
どちらを使うべきか
| アプローチ | 使用するタイミング |
|---|---|
--content "short text" | 一行の内容、簡単なステータス更新 |
--file path.md | 複数行のコンテンツ、書式付きの markdown、仕様書、ドキュメント |
--file path.md --cleanup | 一時的なコンテンツ (エージェントがファイルを書き込み、ClickUp にプッシュし、ファイルを削除する) |
--file は次と組み合わせて使用できます: create-doc、create-page、edit-page、comment、description、create-list、update-list
タスク/リスト/スペース/ドキュメントの URL 形式
このスキルは、以下の ClickUp URL 形式を認識します。
タスク:
https://app.clickup.com/t/{task_id}https://app.clickup.com/{team_id}/v/li/{list_id}?p={task_id}- カスタムタスク ID:
#DEV-123またはDEV-123 - 直接タスク ID:
86a1b2c3d
リスト:
https://app.clickup.com/{team_id}/v/li/{list_id}- 直接リスト ID:
901111220963
スペース:
https://app.clickup.com/{team_id}/v/s/{space_id}- 直接スペース ID:
20128955
ドキュメント:
https://app.clickup.com/{team_id}/v/dc/{doc_id}https://app.clickup.com/{team_id}/docs/{doc_id}- 直接ドキュメント ID:
abc123def
使用する場面
タスク:
- コンテキストの把握:作業を始める前にタスクの詳細を確認します
- タスクのすばやい作成:ターミナルを離れずにタスクを作成します
- 毎日のスタンドアップ:
my-tasksを使って自分の担当タスクを確認します - ステータスの更新:作業の進捗に応じてコメントを投稿します
- タスク管理:担当者の割り当て、優先度の設定、期限の設定を行います
- コラボレーション:最近のコメントでコンテキストを確認し、ウォッチャーを追加します
- タスクの整理:タスクを分類するタグを追加します
- タスクのリンク:コミットメッセージでタスク ID を参照します
- セッションの追跡:
claimでタスクを確保し、後で作業を再開できるようにします
ドキュメント:
- ドキュメント作成:プロジェクトのドキュメントを作成、管理します
- ナレッジベース:リファレンスガイドや Wiki を作成します
- 議事録:会議の議事録や決定事項を保存します
- 仕様書:技術仕様を作成、更新します
- すばやい編集:ターミナルを離れずにドキュメントの内容を更新します
- ドキュメントのコラボレーション:ドキュメントのコメントを読み、返信してインラインレビューを行います
コメントスレッドのベストプラクティス
タスクのディスカッションに返信するときは、必ず最初にスレッドのコンテキストを確認してください:
- コメントを投稿する前に、
comments <task> --threadsを実行して既存の会話を確認します。 - ユーザーのメッセージやコンテキストが特定のコメントスレッドを参照している場合(例:スレッド内で返信している場合や、以前の会話を続けている場合)、
comment <task> "text"ではなく、reply <comment_id> "text"を使ってそのスレッド内に投稿します。 commentを使うのは、既存のスレッドに属さない、まったく新しい話題の場合に限ります。- 目安:以前投稿したコメントにスレッド内で返信があった場合、次の返信は
replyを使って同じスレッドに投稿します。
ヒント
- チーム ID、ユーザー ID、その他のフィールドは
accounts.jsonに自動的にキャッシュされます - アカウントで
defaultListIdを設定すると、タスク作成時に list_id を省略できます my-tasksを使うと、自分の担当タスクをすばやく確認できます- 自然言語で日付を指定できます:「tomorrow」、「next friday」、「+3d」
- ステークホルダーに進捗を知らせるため、コメントを投稿します
- 追跡可能性を確保するため、コミットメッセージにタスク ID を含めます
- スクリプトでの使用や他のツールへのパイプには
--jsonを使います - Docs の内容は、入力と出力の両方で Markdown 形式を使います
- Docs API は v3 エンドポイントを使用します(チームベースではなく、ワークスペースベースです)
- カスタムタスク ID に対応しています:
#DEV-123またはDEV-123 - すべてのタスク/コメントのクエリは自動的にページネーションされます(手動でページを処理する必要はありません)
- レート制限は、リトライとバックオフによって自動的に処理されます
リファレンス
使用頻度の低い内容は reference.md にあります。必要に応じて参照してください:
- 出力形式 — タスク、リスト、コメント、ドキュメント、ページの出力例
- 技術的な注意事項 — 機能ごとの Markdown の処理、@メンションの解決、ドキュメントのページ構造、ページネーション
- テスト — スモークテストスイート
- Webhook ウォッチャー — webhook.site と
listen.mjsによるリアルタイムイベント監視 - タスクウォッチャー(ポーリング) —
watch.mjsによる依存関係のない単一タスク/リストの監視 - タスクの一括作成 —
batch-createの JSON プランスキーマと依存関係の設定 - チームのワークフローパターン — リード/ワーカー/QA/ドキュメント担当者の役割分担とフェーズゲートのパターン