コマンド
ルートオプション
以下のオプションはルートの bl コマンドにのみ指定できます。サブコマンドには指定できません。
| オプション | 説明 |
|---|---|
--banner | Backlog CLI バナーを表示して終了 |
グローバルオプション
以下のオプションはすべてのサブコマンドで指定できます。
| オプション | 説明 |
|---|---|
--no-color | カラー出力を無効化 |
--space <SPACE_KEY> | このコマンドのみ対象スペースを上書き |
--verbose / -v | 詳細なログを stderr に出力 |
bl auth
| コマンド | 説明 |
|---|---|
bl auth login | Backlog API キーで認証(スペースの追加または更新)。--no-banner でバナーをスキップ |
bl auth login-oauth | ブラウザ経由の OAuth 2.0 で認証。--port <port> でデフォルトのコールバックポート(54321)を変更。--no-banner でバナーをスキップ |
bl auth status | 現在の認証状態を表示して認証情報を検証 |
bl auth list | 設定済みスペースを一覧表示 |
bl auth use <space-key> | カレントスペースを切り替え |
bl auth keyring | システムキーリングが利用可能か確認 |
bl auth logout [<space-key>] | カレントまたは指定スペースの認証情報を削除 |
bl auth logout --all | すべてのスペースを削除してすべての設定ファイルを削除 |
bl space
Backlog スペースの情報を表示します。
bl space
出力例:
Space key: mycompany
Name: My Company
Language: ja
Timezone: Asia/Tokyo
Formatting: markdown
Created: 2020-01-01T00:00:00Z
Updated: 2024-06-01T00:00:00Z
bl space activities
Backlog スペースの最近のアクティビティを表示します。
bl space activities
bl space activities --count 50 --order asc
bl space activities --activity-type-id 1 --activity-type-id 2 --min-id 100 --json
出力例:
[123] type=1 project=TEST user=John Doe created=2024-06-01T00:00:00Z
[124] type=2 project=TEST user=Jane Smith created=2024-06-02T00:00:00Z
bl space disk-usage
Backlog スペースのディスク使用量を表示します。
スペース管理者権限が必要です。管理者以外のユーザーには 403 Forbidden が返されます。
bl space disk-usage
bl space disk-usage --json
出力例:
Capacity: 5242880 bytes
Issue: 2048 bytes
Wiki: 512 bytes
File: 1024 bytes
Subversion: 64 bytes
Git: 256 bytes
Git LFS: 128 bytes
Details: 3 project(s) — use --json for breakdown
bl space notification
Backlog スペースに設定された通知メッセージを表示します。
bl space notification
bl space notification --json
出力例:
Updated: 2024-06-18T07:55:37Z
Scheduled maintenance on 2024-07-01.
通知が設定されていない場合:
Updated: (not set)
(no notification set)
bl space licence
Backlog スペースのライセンス情報を表示します。
bl space licence
bl space licence --json
出力例:
Contract: premium
Storage: 5242880 / 1073741824 bytes
Start: 2020-01-01
Backlog プランによっては startDate や storageUsage が API レスポンスに含まれない場合があります。
その場合、該当フィールドは (not set) または (unknown) として表示されます:
Contract: (not set)
Storage: (unknown) / 107374182400 bytes
Start: (not set)
bl space update-notification
Backlog スペースの通知メッセージを更新します。
bl space update-notification --content "メンテナンスのお知らせ"
bl space update-notification --content "Hello." --json
出力例:
Updated: 2024-07-01T00:00:00Z
メンテナンスのお知らせ
bl space image
スペースのアイコン画像をダウンロードします。
レスポンスはバイナリデータです。--output / -o で保存先を指定してください。省略した場合は、サーバーが返すファイル名(取得できない場合は space_image)を使ってカレントディレクトリに保存します。
bl space image
bl space image --output my_icon.png
出力例:
Saved: space_image.png (1234 bytes)
bl space upload-attachment
ファイルをスペースの添付ファイルとしてアップロードします。アップロードされた添付ファイルのメタデータを返します。
bl space upload-attachment ./report.pdf
bl space upload-attachment ./image.png --json
出力例:
ID: 1
Name: report.pdf
Size: 204800 bytes
Created: 2024-01-01T00:00:00Z
bl project list
アクセス可能なプロジェクトを一覧表示します。
bl project list
bl project list --json
出力例:
[TEST] Test Project
[PROD] Production [archived]
bl project show
特定のプロジェクトの詳細を表示します。
bl project show <id-or-key>
bl project show <id-or-key> --json
出力例:
ID: 1
Key: TEST
Name: Test Project
Formatting: markdown
Archived: false
bl project activities
特定のプロジェクトの最近のアクティビティを表示します。
bl project activities <id-or-key>
bl project activities <id-or-key> --json
bl project activities <id-or-key> --count 20 --order asc
bl project activities <id-or-key> --activity-type-id 1 --activity-type-id 2
bl project activities <id-or-key> --min-id 100 --max-id 200
出力例:
[123] type=1 project=TEST user=John Doe created=2024-06-01T00:00:00Z
bl project disk-usage
特定のプロジェクトのディスク使用量を表示します。
スペース管理者権限が必要です。管理者以外のユーザーには 403 Forbidden が返されます。
bl project disk-usage <id-or-key>
bl project disk-usage <id-or-key> --json
出力例:
Issue: 2048 bytes
Wiki: 512 bytes
Document: 0 bytes
File: 1024 bytes
Subversion: 64 bytes
Git: 256 bytes
Git LFS: 128 bytes
bl project user list
特定のプロジェクトのメンバーを一覧表示します。
bl project user list <id-or-key>
bl project user list <id-or-key> --json
出力例:
[john] John Doe
[jane] Jane Smith
bl project user add
数値ユーザー ID を指定してプロジェクトにユーザーを追加します。
bl project user add <id-or-key> --user-id <user-id>
bl project user add <id-or-key> --user-id <user-id> --json
出力例:
Added: [john] John Doe
bl project user delete
数値ユーザー ID を指定してプロジェクトからユーザーを削除します。
bl project user delete <id-or-key> --user-id <user-id>
bl project user delete <id-or-key> --user-id <user-id> --json
出力例:
Deleted: [john] John Doe
bl project admin list
特定のプロジェクトの管理者を一覧表示します。
bl project admin list <id-or-key>
bl project admin list <id-or-key> --json
出力例:
[admin1] Alice Admin
bl project admin add
数値ユーザー ID を指定してユーザーをプロジェクト管理者に追加します。
bl project admin add <id-or-key> --user-id <user-id>
bl project admin add <id-or-key> --user-id <user-id> --json
出力例:
Added: [john] John Doe
bl project admin delete
数値ユーザー ID を指定してユーザーをプロジェクト管理者から削除します。
bl project admin delete <id-or-key> --user-id <user-id>
bl project admin delete <id-or-key> --user-id <user-id> --json
出力例:
Deleted: [john] John Doe
bl project status list
特定のプロジェクトの課題ステータスを一覧表示します。
bl project status list <id-or-key>
bl project status list <id-or-key> --json
出力例:
[1] Open
[2] In Progress
[3] Resolved
[4] Closed
bl project status add
プロジェクトにステータスを追加します。
bl project status add <id-or-key> --name <name> --color <color>
bl project status add <id-or-key> --name <name> --color <color> --json
--color の値は # プレフィックス付きの 6 桁の hex カラーコード(例: #ed8077)を指定します。CSS カラー名や省略 hex 形式は受け付けられません。
出力例:
Added: [5] In Review
bl project status update
プロジェクトのステータスを更新します。
bl project status update <id-or-key> --status-id <id> --name <name>
bl project status update <id-or-key> --status-id <id> --color <color>
bl project status update <id-or-key> --status-id <id> --name <name> --color <color> --json
--name または --color の少なくともどちらかを指定する必要があります。
出力例:
Updated: [5] In Review
bl project status delete
プロジェクトのステータスを削除します。削除されたステータスの課題は代替ステータスに移行されます。
bl project status delete <id-or-key> --status-id <id> --substitute-status-id <id>
bl project status delete <id-or-key> --status-id <id> --substitute-status-id <id> --json
出力例:
Deleted: [5] In Review
bl project status reorder
表示順序を指定してプロジェクトのステータスを並べ替えます。
bl project status reorder <id-or-key> --status-id <id1> --status-id <id2> ...
bl project status reorder <id-or-key> --status-id <id1> --status-id <id2> --json
出力例:
[2] In Progress
[1] Open
[3] Resolved
[4] Closed
bl project issue-type list
特定のプロジェクトの課題種別を一覧表示します。
bl project issue-type list <id-or-key>
bl project issue-type list <id-or-key> --json
出力例:
[1] Bug
[2] Task
[3] Feature Request
bl project issue-type add
プロジェクトに課題種別を追加します。
bl project issue-type add <id-or-key> --name <name> --color <color>
bl project issue-type add <id-or-key> --name <name> --color <color> --json
--color は # プレフィックス付きの6桁 hex コード(例: #e30000)を指定してください。
出力例:
Added: [1] Bug
bl project issue-type update
プロジェクトの課題種別を更新します。
bl project issue-type update <id-or-key> --issue-type-id <id> --name <name>
bl project issue-type update <id-or-key> --issue-type-id <id> --color <color>
bl project issue-type update <id-or-key> --issue-type-id <id> --name <name> --color <color> --json
--name または --color の少なくとも一方を指定してください。--color は有効な hex コードである必要があります。
出力例:
Updated: [1] Bug
bl project issue-type delete
プロジェクトの課題種別を削除します。削除された種別の課題は代替種別に移動されます。
bl project issue-type delete <id-or-key> --issue-type-id <id> --substitute-issue-type-id <id>
bl project issue-type delete <id-or-key> --issue-type-id <id> --substitute-issue-type-id <id> --json
--substitute-issue-type-id は --issue-type-id と異なる値を指定してください。
出力例:
Deleted: [1] Bug
bl project category list
特定のプロジェクトのカテゴリーを一覧表示します。
bl project category list <id-or-key>
bl project category list <id-or-key> --json
出力例:
[11] Development
[12] Design
bl project category add
プロジェクトにカテゴリーを追加します。
bl project category add <id-or-key> --name <name>
bl project category add <id-or-key> --name <name> --json
出力例:
Added: [11] Development
bl project category update
プロジェクトのカテゴリーを更新します。
bl project category update <id-or-key> --category-id <id> --name <name>
bl project category update <id-or-key> --category-id <id> --name <name> --json
出力例:
Updated: [11] Development
bl project category delete
プロジェクトのカテゴリーを削除します。
bl project category delete <id-or-key> --category-id <id>
bl project category delete <id-or-key> --category-id <id> --json
出力例:
Deleted: [11] Development
bl project version list
特定のプロジェクトのバージョン(マイルストーン)を一覧表示します。
bl project version list <id-or-key>
bl project version list <id-or-key> --json
出力例:
[3] Version 0.1 (2024-01-01T00:00:00Z → 2024-01-31T00:00:00Z)
[4] Version 0.2 [archived]
bl project version add
プロジェクトにバージョン(マイルストーン)を追加します。
bl project version add <id-or-key> --name "v1.0"
bl project version add <id-or-key> --name "v1.0" --start-date 2024-01-01 --release-due-date 2024-03-31
bl project version add <id-or-key> --name "v1.0" --description "最初のリリース" --json
| フラグ | デフォルト | 説明 |
|---|---|---|
--name | — | バージョン名(必須) |
--description | — | 説明 |
--start-date | — | 開始日(YYYY-MM-DD) |
--release-due-date | — | リリース期限日(YYYY-MM-DD) |
出力例:
Added: [5] v1.0 (2024-01-01 → 2024-03-31)
bl project version update
プロジェクトのバージョンを更新します。
bl project version update <id-or-key> --version-id 5 --name "v1.0.1"
bl project version update <id-or-key> --version-id 5 --name "v1.0" --archived true --json
| フラグ | デフォルト | 説明 |
|---|---|---|
--version-id | — | バージョン ID(必須) |
--name | — | バージョン名(必須) |
--description | — | 説明 |
--start-date | — | 開始日(YYYY-MM-DD) |
--release-due-date | — | リリース期限日(YYYY-MM-DD) |
--archived | — | true でアーカイブ、false で解除 |
出力例:
Updated: [5] v1.0.1 (2024-01-01 → 2024-03-31)
bl project version delete
プロジェクトからバージョンを削除します。
bl project version delete <id-or-key> --version-id 5
bl project version delete <id-or-key> --version-id 5 --json
| フラグ | デフォルト | 説明 |
|---|---|---|
--version-id | — | バージョン ID(必須) |
出力例:
Deleted: [5] v1.0
bl project custom-field list
特定のプロジェクトのカスタム属性を一覧表示します。
bl project custom-field list <id-or-key>
bl project custom-field list <id-or-key> --json
出力例:
[1] Priority (type:6)
[2] Severity (type:7) [required]
bl project custom-field add
プロジェクトにカスタム属性を追加します。
bl project custom-field add <id-or-key> --type-id 6 --name "Priority"
bl project custom-field add <id-or-key> --type-id 1 --name "Notes" --description "自由入力" --required true --json
| フラグ | デフォルト | 説明 |
|---|---|---|
--type-id | — | 属性タイプ(必須): 1=文字列, 2=文章, 3=数値, 4=日付, 5=単一リスト, 6=複数リスト, 7=チェックボックス, 8=ラジオボタン |
--name | — | 属性名(必須) |
--description | — | 説明 |
--required | — | true で必須にする |
出力例:
Added: [1] Priority (type:6)
bl project custom-field update
プロジェクトのカスタム属性を更新します。--name、--description、--required のいずれかを必ず指定してください。
bl project custom-field update <id-or-key> --custom-field-id 1 --name "Importance"
bl project custom-field update <id-or-key> --custom-field-id 1 --required true --json
| フラグ | デフォルト | 説明 |
|---|---|---|
--custom-field-id | — | カスタム属性 ID(必須) |
--name | — | 属性名 |
--description | — | 説明 |
--required | — | true で必須にする、false で解除 |
出力例:
Updated: [1] Importance (type:6)
bl project custom-field delete
プロジェクトからカスタム属性を削除します。
bl project custom-field delete <id-or-key> --custom-field-id 1
bl project custom-field delete <id-or-key> --custom-field-id 1 --json
| フラグ | デフォルト | 説明 |
|---|---|---|
--custom-field-id | — | カスタム属性 ID(必須) |
出力例:
Deleted: [1] Priority (type:6)
bl project custom-field item add
リスト型カスタム属性に項目を追加します。
bl project custom-field item add <id-or-key> --custom-field-id 1 --name "High"
bl project custom-field item add <id-or-key> --custom-field-id 1 --name "High" --json
| フラグ | デフォルト | 説明 |
|---|---|---|
--custom-field-id | — | カスタム属性 ID(必須) |
--name | — | 項目名(必須) |
bl project custom-field item update
リスト型カスタム属性の項目を更新します。
bl project custom-field item update <id-or-key> --custom-field-id 1 --item-id 10 --name "Very High"
bl project custom-field item update <id-or-key> --custom-field-id 1 --item-id 10 --name "Very High" --json
| フラグ | デフォルト | 説明 |
|---|---|---|
--custom-field-id | — | カスタム属性 ID(必須) |
--item-id | — | 項目 ID(必須) |
--name | — | 項目名(必須) |
bl project custom-field item delete
リスト型カスタム属性から項目を削除します。
bl project custom-field item delete <id-or-key> --custom-field-id 1 --item-id 10
bl project custom-field item delete <id-or-key> --custom-field-id 1 --item-id 10 --json
| フラグ | デフォルト | 説明 |
|---|---|---|
--custom-field-id | — | カスタム属性 ID(必須) |
--item-id | — | 項目 ID(必須) |
bl project team list
プロジェクトに割り当てられたチームの一覧を表示します。
bl project team list <id-or-key>
bl project team list <id-or-key> --json
bl project team add
プロジェクトにチームを追加します。
bl project team add <id-or-key> --team-id 1
bl project team add <id-or-key> --team-id 1 --json
| フラグ | デフォルト | 説明 |
|---|---|---|
--team-id | — | 追加するチームの数値 ID(必須) |
bl project team delete
プロジェクトからチームを削除します。
bl project team delete <id-or-key> --team-id 1
bl project team delete <id-or-key> --team-id 1 --json
| フラグ | デフォルト | 説明 |
|---|---|---|
--team-id | — | 削除するチームの数値 ID(必須) |
bl project webhook list
プロジェクトに定義された Webhook の一覧を表示します。
bl project webhook list <id-or-key>
bl project webhook list <id-or-key> --json
bl project webhook show
特定の Webhook の詳細を表示します。
bl project webhook show <id-or-key> <webhook-id>
bl project webhook show <id-or-key> <webhook-id> --json
bl project webhook add
プロジェクトに Webhook を追加します。
bl project webhook add <id-or-key> --name "Deploy hook" --hook-url "https://example.com/hook"
bl project webhook add <id-or-key> --name "All events" --hook-url "https://example.com/hook" --all-event true --json
bl project webhook add <id-or-key> --name "Filtered" --hook-url "https://example.com/hook" --activity-type-id 1 --activity-type-id 2
| フラグ | デフォルト | 説明 |
|---|---|---|
--name | — | Webhook 名(必須) |
--hook-url | — | Webhook URL(必須) |
--description | — | 説明 |
--all-event | — | 全イベントで発火するか(true/false) |
--activity-type-id | — | 発火させるアクティビティタイプ ID(複数指定可) |
bl project webhook update
Webhook を更新します。--name、--hook-url、--description、--all-event、--activity-type-id のいずれかが必須です。
bl project webhook update <id-or-key> <webhook-id> --name "New Name"
bl project webhook update <id-or-key> <webhook-id> --hook-url "https://new.example.com/hook" --json
| フラグ | デフォルト | 説明 |
|---|---|---|
--name | — | 新しい Webhook 名 |
--hook-url | — | 新しい Webhook URL |
--description | — | 新しい説明 |
--all-event | — | 全イベントで発火するか(true/false) |
--activity-type-id | — | アクティビティタイプ ID(複数指定可;既存リストを置換) |
bl project webhook delete
プロジェクトから Webhook を削除します。
bl project webhook delete <id-or-key> <webhook-id>
bl project webhook delete <id-or-key> <webhook-id> --json
bl project create
新しいプロジェクトを作成します。
bl project create --name "My Project" --key MYPRJ
bl project create --name "My Project" --key MYPRJ --chart-enabled --subtasking-enabled
bl project create --name "My Project" --key MYPRJ --text-formatting-rule backlog --json
| フラグ | デフォルト | 説明 |
|---|---|---|
--name | — | プロジェクト名(必須) |
--key | — | プロジェクトキー:大文字・数字・アンダースコア、2〜10文字(必須) |
--chart-enabled | false | バーンダウンチャート機能を有効化 |
--subtasking-enabled | false | サブタスク機能を有効化 |
--text-formatting-rule | markdown | backlog または markdown |
--json | — | JSON 形式で出力 |
出力例:
ID: 1
Key: MYPRJ
Name: My Project
Formatting: markdown
Archived: false
bl project update
既存のプロジェクトを更新します。少なくとも 1 つのフィールドを指定する必要があります。
bl project update <id-or-key> --name "New Name"
bl project update <id-or-key> --key NEWKEY --chart-enabled true
bl project update <id-or-key> --archived true --json
| フラグ | 説明 |
|---|---|
--name | 新しいプロジェクト名 |
--key | 新しいプロジェクトキー |
--chart-enabled | true または false |
--subtasking-enabled | true または false |
--text-formatting-rule | backlog または markdown |
--archived | true または false |
--json | JSON 形式で出力 |
出力例:
ID: 1
Key: MYPRJ
Name: New Name
Formatting: markdown
Archived: false
bl project delete
プロジェクトを完全に削除します。
bl project delete <id-or-key>
bl project delete <id-or-key> --json
出力例:
Deleted: My Project (MYPRJ)
bl project image
プロジェクトのアイコン画像をダウンロードします。
レスポンスはバイナリデータです。--output / -o で保存先を指定してください。省略した場合は、サーバーが返すファイル名(ファイル名がない場合や attachment などの汎用プレースホルダーの場合は project_image)を使ってカレントディレクトリに保存します。
bl project image <id-or-key>
bl project image <id-or-key> --output my_icon.png
出力例:
Saved: project_image (1234 bytes)
bl issue list
オプションのフィルターで課題を一覧表示します。
bl issue list
bl issue list --project-id 1 --status-id 1
bl issue list --issue-type-id 1 --category-id 2 --milestone-id 3
bl issue list --parent-child not-child --keyword "login" --count 50
bl issue list --json
--parent-child の値: all、not-child、child、standalone、parent
出力例:
[TEST-1] Fix login issue (Open, Normal, -)
[TEST-2] Add dark mode (In Progress, Normal, John Doe)
bl issue count
オプションのフィルターで課題数をカウントします。bl issue list と同じフィルターを使用できます。
bl issue count
bl issue count --project-id 1 --issue-type-id 1 --parent-child not-child --json
出力例:
42
bl issue show
特定の課題の詳細を表示します。
bl issue show <id-or-key>
bl issue show TEST-1 --json
出力例:
TEST-1 Fix login issue
Status: Open
Priority: Normal
Type: Bug
Assignee: -
Created: 2024-01-01T00:00:00Z
Updated: 2024-06-01T00:00:00Z
bl issue create
新しい課題を作成します。--project-id、--summary、--issue-type-id、--priority-id が必須です。
bl issue create --project-id 1 --summary "Fix login" --issue-type-id 1 --priority-id 2
bl issue create --project-id 1 --summary "Bug" --issue-type-id 1 --priority-id 2 \
--description "Details..." --assignee-id 123 --due-date 2024-12-31 --json
優先度 ID: 1 = 高、2 = 中、3 = 低
bl issue update
既存の課題を更新します。すべてのフィールドはオプションです。
bl issue update TEST-1 --summary "Updated summary"
bl issue update TEST-1 --status-id 2 --comment "Fixed in v1.2" --json
bl issue delete
課題を削除します。
bl issue delete TEST-1
bl issue delete TEST-1 --json
出力例:
Deleted: TEST-1
bl issue comment list
課題のコメントを一覧表示します。
bl issue comment list TEST-1
bl issue comment list TEST-1 --json
出力例:
[1] John Doe (2024-01-01T00:00:00Z): Fixed the issue.
[2] Jane Smith (2024-01-02T00:00:00Z): Confirmed.
bl issue comment add
課題にコメントを追加します。
bl issue comment add TEST-1 --content "This is a comment"
bl issue comment add TEST-1 --content "Done" --json
bl issue comment update
既存のコメントを更新します。
bl issue comment update TEST-1 42 --content "Updated comment"
bl issue comment update TEST-1 42 --content "Fixed" --json
bl issue comment delete
コメントを削除します。
bl issue comment delete TEST-1 42
bl issue comment delete TEST-1 42 --json
bl issue comment count
課題のコメント数を取得します。
bl issue comment count TEST-1
bl issue comment count TEST-1 --json
bl issue comment show
特定のコメントを表示します。
bl issue comment show TEST-1 42
bl issue comment show TEST-1 42 --json
bl issue comment notification list
コメントの通知一覧を取得します。
bl issue comment notification list TEST-1 42
bl issue comment notification list TEST-1 42 --json
bl issue comment notification add
コメントに通知を追加します。
bl issue comment notification add TEST-1 42 --notified-user-id 1
bl issue comment notification add TEST-1 42 --notified-user-id 1 --notified-user-id 2 --json
bl issue attachment list
課題の添付ファイルを一覧表示します。
bl issue attachment list TEST-1
bl issue attachment list TEST-1 --json
出力例:
[1] screenshot.png (204800 bytes)
[2] log.txt (1024 bytes)
bl issue attachment get
課題の添付ファイルをダウンロードします。
bl issue attachment get TEST-1 1
bl issue attachment get TEST-1 1 --output ./downloaded.png
--output で指定したパス、または現在のディレクトリに元のファイル名で保存します。
出力例:
Saved: screenshot.png (204800 bytes)
bl issue attachment delete
課題の添付ファイルを削除します。
bl issue attachment delete TEST-1 1
bl issue attachment delete TEST-1 1 --json
bl issue participant list
課題の参加者一覧を取得します。
bl issue participant list TEST-1
bl issue participant list TEST-1 --json
bl issue shared-file list
課題にリンクされた共有ファイルの一覧を取得します。
bl issue shared-file list TEST-1
bl issue shared-file list TEST-1 --json
bl issue shared-file link
課題に共有ファイルをリンクします。
bl issue shared-file link TEST-1 --shared-file-id 1
bl issue shared-file link TEST-1 --shared-file-id 1 --shared-file-id 2 --json
bl issue shared-file unlink
課題から共有ファイルのリンクを解除します。
bl issue shared-file unlink TEST-1 1
bl issue shared-file unlink TEST-1 1 --json
bl document list
ドキュメントを一覧表示します。
bl document list --project-id 1
bl document list --project-id 1 --keyword design
bl document list --project-id 1 --count 50 --offset 0 --json
出力例:
[abc123] Design Document
[def456] API Reference
bl document tree
プロジェクトのドキュメントツリーを表示します。
bl document tree TEST
bl document tree TEST --json
出力例:
Project: 1
Active:
Root [root-id]
Design Document [abc123]
Frontend [def456]
Backend [ghi789]
Trash:
Trash [trash-id]
bl document show
ドキュメントの詳細を表示します。
bl document show abc123
bl document show abc123 --json
出力例:
ID: abc123
Title: Design Document
Project ID: 1
Status: 1
Content:
Hello world
Created: Taro (2024-01-01T00:00:00Z)
Updated: Taro (2024-06-01T00:00:00Z)
bl document create
新しいドキュメントを作成します。
bl document create --project-id 1 --title "New Doc" --content "# New Doc"
bl document create --project-id 1 --title "Child Doc" --parent-id abc123 --json
bl document delete
ドキュメントを削除します。
bl document delete abc123
bl document delete abc123 --json
bl document attachment get
ドキュメントの添付ファイルをダウンロードします。
bl document attachment get abc123 1
bl document attachment get abc123 1 --output /path/to/file.pdf
bl wiki list
プロジェクトの Wiki ページを一覧表示します。
bl wiki list TEST
bl wiki list TEST --keyword setup
bl wiki list TEST --json
出力例:
Home [guide, onboarding]
Setup
API Reference
bl wiki show
Wiki ページの内容を表示します。
bl wiki show 12345
bl wiki show 12345 --json
出力例:
Home
Tags: guide, onboarding
Created: 2024-01-01T00:00:00Z
Updated: 2024-06-01T00:00:00Z
# Home
Welcome to the project wiki!
bl wiki create
新しい Wiki ページを作成します。
bl wiki create --project-id 1 --name "Setup" --content "# Setup\nSee README."
bl wiki create --project-id 1 --name "Setup" --content "# Setup" --mail-notify --json
bl wiki update
既存の Wiki ページを更新します。--name または --content のいずれかが必須です。
bl wiki update 12345 --content "# Updated content"
bl wiki update 12345 --name "New Title" --content "New content" --mail-notify
bl wiki update 12345 --name "Renamed" --json
bl wiki delete
Wiki ページを削除します。
bl wiki delete 12345
bl wiki delete 12345 --mail-notify --json
bl wiki history
Wiki ページの変更履歴を表示します。
bl wiki history 12345
bl wiki history 12345 --json
出力例:
v3 Home — 2024-06-01T00:00:00Z
v2 Home — 2024-03-15T00:00:00Z
v1 Home — 2024-01-01T00:00:00Z
bl wiki count
プロジェクト内の Wiki ページ数を取得します。
bl wiki count
bl wiki count TEST
bl wiki count TEST --json
出力例:
42
bl wiki tag list
Wiki ページで使われているタグを一覧表示します。
bl wiki tag list
bl wiki tag list TEST
bl wiki tag list TEST --json
出力例:
[1] guide
[2] api
bl wiki star list
Wiki ページのスターを一覧表示します。
bl wiki star list 12345
bl wiki star list 12345 --json
出力例:
[1] Home (John Doe)
bl wiki attachment list
Wiki ページの添付ファイルを一覧表示します。
bl wiki attachment list 12345
bl wiki attachment list 12345 --json
出力例:
[1] diagram.png (204800 bytes)
[2] notes.txt (1024 bytes)
bl wiki attachment add
事前アップロード済みの添付ファイル ID を指定して Wiki ページに添付ファイルを追加します。
bl wiki attachment add 12345 --attachment-id 1
bl wiki attachment add 12345 --attachment-id 1 --attachment-id 2 --json
bl wiki attachment get
Wiki ページの添付ファイルをダウンロードします。
bl wiki attachment get 12345 1
bl wiki attachment get 12345 1 --output ./downloads/diagram.png
bl wiki attachment delete
Wiki ページから添付ファイルを削除します。
bl wiki attachment delete 12345 1
bl wiki attachment delete 12345 1 --json
bl wiki shared-file list
Wiki ページにリンクされている共有ファイルを一覧表示します。
bl wiki shared-file list 12345
bl wiki shared-file list 12345 --json
出力例:
[1] /docs/spec.pdf (204800 bytes)
bl wiki shared-file link
共有ファイルを Wiki ページにリンクします。
bl wiki shared-file link 12345 --shared-file-id 1
bl wiki shared-file link 12345 --shared-file-id 1 --shared-file-id 2 --json
bl wiki shared-file unlink
Wiki ページから共有ファイルのリンクを解除します。
bl wiki shared-file unlink 12345 1
bl wiki shared-file unlink 12345 1 --json
bl team list
スペース内のチームを一覧表示します。
bl team list
bl team list --json
bl team list --count 20 --order asc
bl team list --offset 10
出力例:
[1] dev-team (3 members)
[2] design-team (2 members)
bl team show
特定のチームの詳細を表示します。
スペースの設定によっては 403 Forbidden が返ることがあります。
bl team show <id>
bl team show <id> --json
出力例:
ID: 1
Name: dev-team
Created: 2024-01-01T00:00:00Z
Updated: 2024-06-01T00:00:00Z
Members:
[2] Developer
[3] Engineer
bl team add
チームを作成します。
スペースの設定によっては 403 Forbidden が返ることがあります。
bl team add --name <name>
bl team add --name <name> --member <user-id> --member <user-id>
bl team add --name <name> --json
出力例:
Created: [1] dev-team (0 members)
bl team update
チームを更新します。--name または --member のいずれか1つ以上が必要です。
スペースの設定によっては 403 Forbidden が返ることがあります。
bl team update <id> --name <new-name>
bl team update <id> --member <user-id> --member <user-id>
bl team update <id> --name <new-name> --json
出力例:
Updated: [1] dev-team (3 members)
bl team delete
チームを削除します。
スペースの設定によっては 403 Forbidden が返ることがあります。
bl team delete <id>
bl team delete <id> --json
出力例:
Deleted: [1] dev-team (3 members)
bl team icon
チームアイコン画像をダウンロードします。
スペースの設定によっては 403 Forbidden が返ることがあります。
bl team icon <id>
bl team icon <id> --output <path>
出力例:
Saved: icon.png (10240 bytes)
bl user activities
特定のユーザーの最近のアクティビティを表示します。
bl user activities <id>
bl user activities <id> --json
bl user activities <id> --count 20 --order asc
bl user activities <id> --activity-type-id 1 --activity-type-id 2
bl user activities <id> --min-id 100 --max-id 200
出力例:
[3153] type=2 project=SUB user=admin created=2024-06-01T00:00:00Z
bl user recently-viewed
認証ユーザーが最近閲覧した課題を表示します。
bl user recently-viewed
bl user recently-viewed --json
bl user recently-viewed --count 20 --order asc
bl user recently-viewed --offset 10
出力例:
[BLG-1] Fix login (Open, -)
[BLG-2] Add dark mode (In Progress, John Doe)
bl user add
新しいユーザーを追加します。スペース管理者権限が必要です。
bl user add --user-id john --password secret --name "John Doe" --mail-address john@example.com --role-type normal
bl user add --user-id john --password secret --name "John Doe" --mail-address john@example.com --role-type normal --json
ロールタイプ: administrator, normal, reporter, viewer, guest-reporter, guest-viewer
出力例:
Added: john (John Doe) [roleType: 2]
bl user update
既存のユーザーを更新します。スペース管理者権限が必要です。
bl user update <id> --name "New Name"
bl user update <id> --mail-address new@example.com --role-type viewer --json
出力例:
Updated: john (New Name) [roleType: 4]
bl user delete
ユーザーを削除します。スペース管理者権限が必要です。
bl user delete <id>
bl user delete <id> --json
出力例:
Deleted: john (John Doe)
bl user recently-viewed-projects
認証ユーザーが最近閲覧したプロジェクトを表示します。
bl user recently-viewed-projects
bl user recently-viewed-projects --count 50 --offset 20 --order asc
bl user recently-viewed-projects --json
出力例:
[MYPRJ] My Project
[TEST] Test Project
bl user recently-viewed-wikis
認証ユーザーが最近閲覧したWikiページを表示します。
bl user recently-viewed-wikis
bl user recently-viewed-wikis --count 50 --offset 20 --order asc
bl user recently-viewed-wikis --json
出力例:
[1] Home (project: 1)
[2] API Reference (project: 2)
bl shared-file list
プロジェクトのディレクトリ内の共有ファイル一覧を表示します。
bl shared-file list <id-or-key>
bl shared-file list <id-or-key> --path docs --count 50 --order asc --json
| オプション | デフォルト | 説明 |
|---|---|---|
--path | ルート | ディレクトリパス |
--count | 20 | 取得件数(1–100) |
--order | — | 並び順(asc または desc) |
--offset | — | ページネーションのオフセット |
出力例:
[1] /test.txt (1024 bytes)
[2] /docs/readme.txt (512 bytes)
bl shared-file get
共有ファイルをダウンロードします。
bl shared-file get <id-or-key> <id>
bl shared-file get <id-or-key> <id> --output /tmp/file.txt
| オプション | デフォルト | 説明 |
|---|---|---|
--output / -o | 元のファイル名 | 保存先パス |
出力例:
Saved: file.txt (1024 bytes)
bl star add
課題・コメント・Wiki・プルリクエスト・プルリクエストコメントにスターを追加します。 対象は1つだけ指定してください。
bl star add --issue-id <id>
bl star add --comment-id <id>
bl star add --wiki-id <id>
bl star add --pull-request-id <id>
bl star add --pull-request-comment-id <id>
| オプション | デフォルト | 説明 |
|---|---|---|
--issue-id | — | スターをつける課題の ID |
--comment-id | — | スターをつける課題コメントの ID |
--wiki-id | — | スターをつける Wiki ページの ID |
--pull-request-id | — | スターをつけるプルリクエストの ID |
--pull-request-comment-id | — | スターをつけるプルリクエストコメントの ID |
成功時は出力なし(HTTP 204 No Content)。
bl star delete
スターを削除します。
bl star delete <id>
成功時は出力なし(HTTP 204 No Content)。
bl user star list
ユーザーがスターをつけた一覧を表示します。
bl user star list <id>
bl user star list <id> --count 50 --order asc --json
bl user star list <id> --min-id 100 --max-id 200 --json
出力例:
[1] Fix login bug
[2] Add dark mode feature
bl user star count
ユーザーがつけたスターの数を表示します。
bl user star count <id>
bl user star count <id> --since 2024-01-01 --until 2024-12-31 --json
出力例:
42
bl user icon
ユーザーのアイコン画像をダウンロードします。
レスポンスはバイナリデータです。--output / -o で保存先を指定してください。省略した場合は、サーバーが返すファイル名(ファイル名がない場合や attachment などの汎用プレースホルダーの場合は user_icon)を使ってカレントディレクトリに保存します。
bl user icon <id>
bl user icon <id> --output my_icon.png
出力例:
Saved: user_icon (1234 bytes)
bl user list
スペース内のユーザーを一覧表示します。
Space Administrator 権限が必要です。権限がない場合は 403 Forbidden が返ります。
bl user list
bl user list --json
出力例:
[john] John Doe
[jane] Jane Smith
[12345] Bot User
bl user show
数値 ID でユーザーの詳細を表示します。
bl user show <id>
bl user show <id> --json
出力例:
ID: 123
User ID: john
Name: John Doe
Mail: john@example.com
Role: 1
Lang: ja
Last login: 2024-06-01T00:00:00Z
bl notification list
認証ユーザーの通知一覧を表示します。
bl notification list
bl notification list --json
bl notification list --count 20 --order asc
bl notification list --unread
bl notification list --sender-id 123
出力例:
[101] reason=2 project=TEST issue=TEST-1 read=false created=2024-06-01T00:00:00Z
[102] reason=6 project=TEST issue=TEST-2 read=true created=2024-06-02T00:00:00Z
bl notification count
認証ユーザーの未読通知数を表示します。
bl notification count
bl notification count --json
出力例:
3
bl notification read <id>
指定した通知を既読にします。
bl notification read <id>
bl notification reset-unread
未読通知数をリセットします。 個々の通知が既読になるわけではなく、未読カウンターがリセットされます。
bl notification reset-unread
出力例:
Unread count reset.
bl watch list
ユーザーのウォッチ一覧を取得します。
bl watch list <user-id> [--order asc|desc] [--sort created|updated|issue-updated] [--count N] [--offset N] [--resource-already-read true|false] [--issue-id ID ...] [--json]
出力例:
[1] ログインバグを修正する (TEST-42)
[2] ドキュメントを更新する (TEST-7)
bl watch count
ユーザーのウォッチ数を取得します。
bl watch count <user-id> [--resource-already-read true|false] [--already-read true|false] [--json]
出力例:
5
bl watch show <id>
ウォッチの詳細を表示します。
bl watch show <id> [--json]
出力例:
[1] ログインバグを修正する (TEST-42)
note: あとで確認する
bl watch add
ウォッチを追加します。
bl watch add --issue <issue-id-or-key> [--note NOTE] [--json]
出力例:
Added: [1] ログインバグを修正する (TEST-42)
bl watch update <id>
ウォッチのノートを更新します。
bl watch update <id> --note NOTE [--json]
出力例:
Updated: [1] ログインバグを修正する (TEST-42)
bl watch delete <id>
ウォッチを削除します。
bl watch delete <id> [--json]
出力例:
Deleted: [1] ログインバグを修正する (TEST-42)
bl watch read <id>
ウォッチを既読にします。
bl watch read <id>
成功時は出力されません(HTTP 204 No Content)。
bl priority list
課題優先度の一覧を表示します。
bl priority list [--json]
出力例:
[2] 高
[3] 中
[4] 低
bl resolution list
課題解決理由の一覧を表示します。
bl resolution list [--json]
出力例:
[0] 対応済み
[1] 対応しない
[2] 無効
[3] 重複
[4] 再現しない
bl pr list
リポジトリのプルリクエスト一覧を表示します。
bl pr list <project-id-or-key> <repo-id-or-name>
bl pr list <project-id-or-key> <repo-id-or-name> --json
bl pr count
リポジトリのプルリクエスト数を表示します。
bl pr count <project-id-or-key> <repo-id-or-name>
bl pr count <project-id-or-key> <repo-id-or-name> --json
bl pr show
プルリクエストの詳細を表示します。
bl pr show <project-id-or-key> <repo-id-or-name> <number>
bl pr show <project-id-or-key> <repo-id-or-name> <number> --json
bl pr create
プルリクエストを作成します。
bl pr create <project-id-or-key> <repo-id-or-name> --summary <summary> --base <base> --branch <branch>
bl pr create <project-id-or-key> <repo-id-or-name> --summary <summary> --base <base> --branch <branch> --json
bl pr update
プルリクエストを更新します。--summary、--description、--base、--issue-id、--assignee-id、--comment のいずれか1つ以上が必要です。
bl pr update <project-id-or-key> <repo-id-or-name> <number> --summary <summary>
bl pr update <project-id-or-key> <repo-id-or-name> <number> --summary <summary> --json
bl pr comment list
プルリクエストのコメント一覧を表示します。
bl pr comment list <project-id-or-key> <repo-id-or-name> <number>
bl pr comment list <project-id-or-key> <repo-id-or-name> <number> --json
bl pr comment count
プルリクエストのコメント数を表示します。
bl pr comment count <project-id-or-key> <repo-id-or-name> <number>
bl pr comment count <project-id-or-key> <repo-id-or-name> <number> --json
bl pr comment add
プルリクエストにコメントを追加します。
bl pr comment add <project-id-or-key> <repo-id-or-name> <number> --content <content>
bl pr comment add <project-id-or-key> <repo-id-or-name> <number> --content <content> --json
bl pr comment update
プルリクエストのコメントを更新します。
bl pr comment update <project-id-or-key> <repo-id-or-name> <number> <comment-id> --content <content>
bl pr comment update <project-id-or-key> <repo-id-or-name> <number> <comment-id> --content <content> --json
bl pr attachment list
プルリクエストの添付ファイル一覧を表示します。
bl pr attachment list <project-id-or-key> <repo-id-or-name> <number>
bl pr attachment list <project-id-or-key> <repo-id-or-name> <number> --json
bl pr attachment get
プルリクエストの添付ファイルをダウンロードします。
bl pr attachment get <project-id-or-key> <repo-id-or-name> <number> <attachment-id>
bl pr attachment get <project-id-or-key> <repo-id-or-name> <number> <attachment-id> --output <path>
bl pr attachment delete
プルリクエストの添付ファイルを削除します。
bl pr attachment delete <project-id-or-key> <repo-id-or-name> <number> <attachment-id>
bl pr attachment delete <project-id-or-key> <repo-id-or-name> <number> <attachment-id> --json
bl git repo list
プロジェクトの Git リポジトリ一覧を表示します。
bl git repo list <project-id-or-key>
bl git repo list <project-id-or-key> --json
出力例:
main
develop
bl git repo show
Git リポジトリの詳細を表示します。
bl git repo show <project-id-or-key> <repo-id-or-name>
bl git repo show <project-id-or-key> <repo-id-or-name> --json
出力例:
main
Description: メインリポジトリ
HTTP URL: https://example.backlog.com/git/TEST/main.git
SSH URL: git@example.backlog.com:/TEST/main.git
Created: 2024-01-01T00:00:00Z
Updated: 2024-01-02T00:00:00Z
bl rate-limit
API レート制限の現在の状況を表示します。
bl rate-limit
bl rate-limit --json
出力例:
Read: limit=600, remaining=599, reset=1698230400
Update: limit=150, remaining=150, reset=1698230400
Search: limit=150, remaining=150, reset=1698230400
Icon: limit=60, remaining=60, reset=1698230400
Icon 行は Backlog プランにアイコンのレート制限カテゴリが含まれる場合のみ表示されます。
コマンドカバレッジ
Backlog API v2 エンドポイントと bl コマンドの対応表です。
Space
| コマンド | API エンドポイント | 状態 |
|---|---|---|
bl space | GET /api/v2/space | ✅ 実装済み |
bl space activities | GET /api/v2/space/activities | ✅ 実装済み |
bl space disk-usage | GET /api/v2/space/diskUsage | ✅ 実装済み |
bl space notification | GET /api/v2/space/notification | ✅ 実装済み |
bl space licence | GET /api/v2/space/licence | ✅ 実装済み |
bl space update-notification | PUT /api/v2/space/notification | ✅ 実装済み |
bl space image | GET /api/v2/space/image | ✅ 実装済み |
bl space upload-attachment <file> | POST /api/v2/space/attachment | ✅ 実装済み |
Projects
| コマンド | API エンドポイント | 状態 |
|---|---|---|
bl project list | GET /api/v2/projects | ✅ 実装済み |
bl project show <id-or-key> | GET /api/v2/projects/{projectIdOrKey} | ✅ 実装済み |
bl project create | POST /api/v2/projects | ✅ 実装済み |
bl project update <id-or-key> | PATCH /api/v2/projects/{projectIdOrKey} | ✅ 実装済み |
bl project delete <id-or-key> | DELETE /api/v2/projects/{projectIdOrKey} | ✅ 実装済み |
bl project activities <id-or-key> | GET /api/v2/projects/{projectIdOrKey}/activities | ✅ 実装済み |
bl project disk-usage <id-or-key> | GET /api/v2/projects/{projectIdOrKey}/diskUsage | ✅ 実装済み |
bl project user list <id-or-key> | GET /api/v2/projects/{projectIdOrKey}/users | ✅ 実装済み |
bl project user add <id-or-key> | POST /api/v2/projects/{projectIdOrKey}/users | ✅ 実装済み |
bl project user delete <id-or-key> | DELETE /api/v2/projects/{projectIdOrKey}/users | ✅ 実装済み |
bl project admin list <id-or-key> | GET /api/v2/projects/{projectIdOrKey}/administrators | ✅ 実装済み |
bl project admin add <id-or-key> | POST /api/v2/projects/{projectIdOrKey}/administrators | ✅ 実装済み |
bl project admin delete <id-or-key> | DELETE /api/v2/projects/{projectIdOrKey}/administrators | ✅ 実装済み |
bl project image <id-or-key> | GET /api/v2/projects/{projectIdOrKey}/image | ✅ 実装済み |
bl project status list <id-or-key> | GET /api/v2/projects/{projectIdOrKey}/statuses | ✅ 実装済み |
bl project status add <id-or-key> | POST /api/v2/projects/{projectIdOrKey}/statuses | ✅ 実装済み |
bl project status update <id-or-key> --status-id <id> | PATCH /api/v2/projects/{projectIdOrKey}/statuses/{id} | ✅ 実装済み |
bl project status delete <id-or-key> --status-id <id> | DELETE /api/v2/projects/{projectIdOrKey}/statuses/{id} | ✅ 実装済み |
bl project status reorder <id-or-key> | PATCH /api/v2/projects/{projectIdOrKey}/statuses/updateDisplayOrder | ✅ 実装済み |
bl project issue-type list <id-or-key> | GET /api/v2/projects/{projectIdOrKey}/issueTypes | ✅ 実装済み |
bl project issue-type add <id-or-key> | POST /api/v2/projects/{projectIdOrKey}/issueTypes | ✅ 実装済み |
bl project issue-type update <id-or-key> --issue-type-id <id> | PATCH /api/v2/projects/{projectIdOrKey}/issueTypes/{id} | ✅ 実装済み |
bl project issue-type delete <id-or-key> --issue-type-id <id> | DELETE /api/v2/projects/{projectIdOrKey}/issueTypes/{id} | ✅ 実装済み |
bl project category list <id-or-key> | GET /api/v2/projects/{projectIdOrKey}/categories | ✅ 実装済み |
bl project category add <id-or-key> | POST /api/v2/projects/{projectIdOrKey}/categories | ✅ 実装済み |
bl project category update <id-or-key> --category-id <id> | PATCH /api/v2/projects/{projectIdOrKey}/categories/{id} | ✅ 実装済み |
bl project category delete <id-or-key> --category-id <id> | DELETE /api/v2/projects/{projectIdOrKey}/categories/{id} | ✅ 実装済み |
bl project version list <id-or-key> | GET /api/v2/projects/{projectIdOrKey}/versions | ✅ 実装済み |
bl project version add <id-or-key> | POST /api/v2/projects/{projectIdOrKey}/versions | ✅ 実装済み |
bl project version update <id-or-key> --version-id <id> | PATCH /api/v2/projects/{projectIdOrKey}/versions/{id} | ✅ 実装済み |
bl project version delete <id-or-key> --version-id <id> | DELETE /api/v2/projects/{projectIdOrKey}/versions/{id} | ✅ 実装済み |
bl project custom-field list <id-or-key> | GET /api/v2/projects/{projectIdOrKey}/customFields | ✅ 実装済み |
bl project custom-field add <id-or-key> | POST /api/v2/projects/{projectIdOrKey}/customFields | ✅ 実装済み |
bl project custom-field update <id-or-key> --custom-field-id <id> | PATCH /api/v2/projects/{projectIdOrKey}/customFields/{id} | ✅ 実装済み |
bl project custom-field delete <id-or-key> --custom-field-id <id> | DELETE /api/v2/projects/{projectIdOrKey}/customFields/{id} | ✅ 実装済み |
bl project custom-field item add <id-or-key> --custom-field-id <id> | POST /api/v2/projects/{projectIdOrKey}/customFields/{id}/items | ✅ 実装済み |
bl project custom-field item update <id-or-key> --custom-field-id <id> --item-id <id> | PATCH /api/v2/projects/{projectIdOrKey}/customFields/{id}/items/{itemId} | ✅ 実装済み |
bl project custom-field item delete <id-or-key> --custom-field-id <id> --item-id <id> | DELETE /api/v2/projects/{projectIdOrKey}/customFields/{id}/items/{itemId} | ✅ 実装済み |
bl project webhook list <id-or-key> | GET /api/v2/projects/{projectIdOrKey}/webhooks | ✅ 実装済み |
bl project webhook show <id-or-key> <webhook-id> | GET /api/v2/projects/{projectIdOrKey}/webhooks/{webhookId} | ✅ 実装済み |
bl project webhook add <id-or-key> | POST /api/v2/projects/{projectIdOrKey}/webhooks | ✅ 実装済み |
bl project webhook update <id-or-key> <webhook-id> | PATCH /api/v2/projects/{projectIdOrKey}/webhooks/{webhookId} | ✅ 実装済み |
bl project webhook delete <id-or-key> <webhook-id> | DELETE /api/v2/projects/{projectIdOrKey}/webhooks/{webhookId} | ✅ 実装済み |
bl project team list <id-or-key> | GET /api/v2/projects/{projectIdOrKey}/teams | ✅ 実装済み |
bl project team add <id-or-key> | POST /api/v2/projects/{projectIdOrKey}/teams | ✅ 実装済み |
bl project team delete <id-or-key> | DELETE /api/v2/projects/{projectIdOrKey}/teams/{teamId} | ✅ 実装済み |
Priorities & Resolutions
| コマンド | API エンドポイント | 状態 |
|---|---|---|
bl priority list | GET /api/v2/priorities | ✅ 実装済み |
bl resolution list | GET /api/v2/resolutions | ✅ 実装済み |
Issues
| コマンド | API エンドポイント | 状態 |
|---|---|---|
bl issue list | GET /api/v2/issues | ✅ 実装済み |
bl issue count | GET /api/v2/issues/count | ✅ 実装済み |
bl issue show <id-or-key> | GET /api/v2/issues/{issueIdOrKey} | ✅ 実装済み |
bl issue create | POST /api/v2/issues | ✅ 実装済み |
bl issue update <id-or-key> | PATCH /api/v2/issues/{issueIdOrKey} | ✅ 実装済み |
bl issue delete <id-or-key> | DELETE /api/v2/issues/{issueIdOrKey} | ✅ 実装済み |
bl issue comment list <id-or-key> | GET /api/v2/issues/{issueIdOrKey}/comments | ✅ 実装済み |
bl issue comment add <id-or-key> | POST /api/v2/issues/{issueIdOrKey}/comments | ✅ 実装済み |
bl issue comment count <id-or-key> | GET /api/v2/issues/{issueIdOrKey}/comments/count | ✅ 実装済み |
bl issue comment show <id-or-key> <comment-id> | GET /api/v2/issues/{issueIdOrKey}/comments/{commentId} | ✅ 実装済み |
bl issue comment update <id-or-key> <comment-id> | PATCH /api/v2/issues/{issueIdOrKey}/comments/{commentId} | ✅ 実装済み |
bl issue comment delete <id-or-key> <comment-id> | DELETE /api/v2/issues/{issueIdOrKey}/comments/{commentId} | ✅ 実装済み |
bl issue comment notification list <id-or-key> <comment-id> | GET /api/v2/issues/{issueIdOrKey}/comments/{commentId}/notifications | ✅ 実装済み |
bl issue comment notification add <id-or-key> <comment-id> | POST /api/v2/issues/{issueIdOrKey}/comments/{commentId}/notifications | ✅ 実装済み |
bl issue attachment list <id-or-key> | GET /api/v2/issues/{issueIdOrKey}/attachments | ✅ 実装済み |
bl issue attachment get <id-or-key> <attachment-id> | GET /api/v2/issues/{issueIdOrKey}/attachments/{attachmentId} | ✅ 実装済み |
bl issue attachment delete <id-or-key> <attachment-id> | DELETE /api/v2/issues/{issueIdOrKey}/attachments/{attachmentId} | ✅ 実装済み |
bl issue participant list <id-or-key> | GET /api/v2/issues/{issueIdOrKey}/participants | ✅ 実装済み |
bl issue shared-file list <id-or-key> | GET /api/v2/issues/{issueIdOrKey}/sharedFiles | ✅ 実装済み |
bl issue shared-file link <id-or-key> | POST /api/v2/issues/{issueIdOrKey}/sharedFiles | ✅ 実装済み |
bl issue shared-file unlink <id-or-key> <shared-file-id> | DELETE /api/v2/issues/{issueIdOrKey}/sharedFiles/{id} | ✅ 実装済み |
Documents
| コマンド | API エンドポイント | 状態 |
|---|---|---|
bl document list | GET /api/v2/documents | ✅ 実装済み |
bl document tree | GET /api/v2/documents/tree | ✅ 実装済み |
bl document show <id> | GET /api/v2/documents/{documentId} | ✅ 実装済み |
bl document create | POST /api/v2/documents | ✅ 実装済み |
bl document delete <id> | DELETE /api/v2/documents/{documentId} | ✅ 実装済み |
bl document attachment get <id> <attachment-id> | GET /api/v2/documents/{documentId}/attachments/{attachmentId} | ✅ 実装済み |
Wiki
| コマンド | API エンドポイント | 状態 |
|---|---|---|
bl wiki list | GET /api/v2/wikis | ✅ 実装済み |
bl wiki count | GET /api/v2/wikis/count | ✅ 実装済み |
bl wiki tag list | GET /api/v2/wikis/tags | ✅ 実装済み |
bl wiki show <id> | GET /api/v2/wikis/{wikiId} | ✅ 実装済み |
bl wiki create | POST /api/v2/wikis | ✅ 実装済み |
bl wiki update <id> | PATCH /api/v2/wikis/{wikiId} | ✅ 実装済み |
bl wiki delete <id> | DELETE /api/v2/wikis/{wikiId} | ✅ 実装済み |
bl wiki history <id> | GET /api/v2/wikis/{wikiId}/history | ✅ 実装済み |
bl wiki star list <id> | GET /api/v2/wikis/{wikiId}/stars | ✅ 実装済み |
bl wiki attachment list <id> | GET /api/v2/wikis/{wikiId}/attachments | ✅ 実装済み |
bl wiki attachment add <id> | POST /api/v2/wikis/{wikiId}/attachments | ✅ 実装済み |
bl wiki attachment get <id> <attachment-id> | GET /api/v2/wikis/{wikiId}/attachments/{attachmentId} | ✅ 実装済み |
bl wiki attachment delete <id> <attachment-id> | DELETE /api/v2/wikis/{wikiId}/attachments/{attachmentId} | ✅ 実装済み |
bl wiki shared-file list <id> | GET /api/v2/wikis/{wikiId}/sharedFiles | ✅ 実装済み |
bl wiki shared-file link <id> | POST /api/v2/wikis/{wikiId}/sharedFiles | ✅ 実装済み |
bl wiki shared-file unlink <id> <shared-file-id> | DELETE /api/v2/wikis/{wikiId}/sharedFiles/{id} | ✅ 実装済み |
Shared Files
| コマンド | API エンドポイント | 状態 |
|---|---|---|
bl shared-file list <id-or-key> | GET /api/v2/projects/{projectIdOrKey}/files/metadata/{path} | ✅ 実装済み |
bl shared-file get <id-or-key> <id> | GET /api/v2/projects/{projectIdOrKey}/files/{sharedFileId} | ✅ 実装済み |
Stars
| コマンド | API エンドポイント | 状態 |
|---|---|---|
bl star add | POST /api/v2/stars | ✅ 実装済み |
bl star delete <id> | DELETE /api/v2/stars/{starId} | ✅ 実装済み |
bl user star list <id> | GET /api/v2/users/{userId}/stars | ✅ 実装済み |
bl user star count <id> | GET /api/v2/users/{userId}/stars/count | ✅ 実装済み |
Pull Requests
| コマンド | API エンドポイント | 状態 |
|---|---|---|
bl pr list <id-or-key> <repo> | GET /api/v2/projects/{projectIdOrKey}/git/repositories/{repoIdOrName}/pullRequests | ✅ 実装済み |
bl pr count <id-or-key> <repo> | GET /api/v2/projects/{projectIdOrKey}/git/repositories/{repoIdOrName}/pullRequests/count | ✅ 実装済み |
bl pr show <id-or-key> <repo> <number> | GET /api/v2/projects/{projectIdOrKey}/git/repositories/{repoIdOrName}/pullRequests/{number} | ✅ 実装済み |
bl pr create <id-or-key> <repo> | POST /api/v2/projects/{projectIdOrKey}/git/repositories/{repoIdOrName}/pullRequests | ✅ 実装済み |
bl pr update <id-or-key> <repo> <number> | PATCH /api/v2/projects/{projectIdOrKey}/git/repositories/{repoIdOrName}/pullRequests/{number} | ✅ 実装済み |
bl pr comment list <id-or-key> <repo> <number> | GET /api/v2/projects/{projectIdOrKey}/git/repositories/{repoIdOrName}/pullRequests/{number}/comments | ✅ 実装済み |
bl pr comment count <id-or-key> <repo> <number> | GET /api/v2/projects/{projectIdOrKey}/git/repositories/{repoIdOrName}/pullRequests/{number}/comments/count | ✅ 実装済み |
bl pr comment add <id-or-key> <repo> <number> | POST /api/v2/projects/{projectIdOrKey}/git/repositories/{repoIdOrName}/pullRequests/{number}/comments | ✅ 実装済み |
bl pr comment update <id-or-key> <repo> <number> <comment-id> | PATCH /api/v2/projects/{projectIdOrKey}/git/repositories/{repoIdOrName}/pullRequests/{number}/comments/{commentId} | ✅ 実装済み |
bl pr attachment list <id-or-key> <repo> <number> | GET /api/v2/projects/{projectIdOrKey}/git/repositories/{repoIdOrName}/pullRequests/{number}/attachments | ✅ 実装済み |
bl pr attachment get <id-or-key> <repo> <number> <attachment-id> | GET /api/v2/projects/{projectIdOrKey}/git/repositories/{repoIdOrName}/pullRequests/{number}/attachments/{attachmentId} | ✅ 実装済み |
bl pr attachment delete <id-or-key> <repo> <number> <attachment-id> | DELETE /api/v2/projects/{projectIdOrKey}/git/repositories/{repoIdOrName}/pullRequests/{number}/attachments/{attachmentId} | ✅ 実装済み |
Git Repositories
| コマンド | API エンドポイント | 状態 |
|---|---|---|
bl git repo list <id-or-key> | GET /api/v2/projects/{projectIdOrKey}/git/repositories | ✅ 実装済み |
bl git repo show <id-or-key> <repo> | GET /api/v2/projects/{projectIdOrKey}/git/repositories/{repoIdOrName} | ✅ 実装済み |
Users
| コマンド | API エンドポイント | 状態 |
|---|---|---|
bl auth status | GET /api/v2/users/myself | ✅ 実装済み(内部) |
bl user list | GET /api/v2/users | ✅ 実装済み |
bl user show <id> | GET /api/v2/users/{userId} | ✅ 実装済み |
bl user add | POST /api/v2/users | ✅ 実装済み |
bl user update <id> | PATCH /api/v2/users/{userId} | ✅ 実装済み |
bl user delete <id> | DELETE /api/v2/users/{userId} | ✅ 実装済み |
bl user activities <id> | GET /api/v2/users/{userId}/activities | ✅ 実装済み |
bl user recently-viewed | GET /api/v2/users/myself/recentlyViewedIssues | ✅ 実装済み |
bl user recently-viewed-projects | GET /api/v2/users/myself/recentlyViewedProjects | ✅ 実装済み |
bl user recently-viewed-wikis | GET /api/v2/users/myself/recentlyViewedWikis | ✅ 実装済み |
bl user star list <id> | GET /api/v2/users/{userId}/stars | ✅ 実装済み |
bl user star count <id> | GET /api/v2/users/{userId}/stars/count | ✅ 実装済み |
bl user icon <id> | GET /api/v2/users/{userId}/icon | ✅ 実装済み |
Notifications
| コマンド | API エンドポイント | 状態 |
|---|---|---|
bl notification list | GET /api/v2/notifications | ✅ 実装済み |
bl notification count | GET /api/v2/notifications/count | ✅ 実装済み |
bl notification read <id> | POST /api/v2/notifications/{notificationId}/markAsRead | ✅ 実装済み |
bl notification reset-unread | POST /api/v2/notifications/markAsRead | ✅ 実装済み |
Watching
| コマンド | API エンドポイント | 状態 |
|---|---|---|
bl watch list | GET /api/v2/users/{userId}/watchings | ✅ 実装済み |
bl watch count | GET /api/v2/users/{userId}/watchings/count | ✅ 実装済み |
bl watch show <id> | GET /api/v2/watchings/{watchingId} | ✅ 実装済み |
bl watch add | POST /api/v2/watchings | ✅ 実装済み |
bl watch update <id> | PATCH /api/v2/watchings/{watchingId} | ✅ 実装済み |
bl watch delete <id> | DELETE /api/v2/watchings/{watchingId} | ✅ 実装済み |
bl watch read <id> | POST /api/v2/watchings/{watchingId}/markAsRead | ✅ 実装済み |
Teams
| コマンド | API エンドポイント | 状態 |
|---|---|---|
bl team list | GET /api/v2/teams | ✅ 実装済み |
bl team show <id> | GET /api/v2/teams/{teamId} | ✅ 実装済み |
bl team add | POST /api/v2/teams | ✅ 実装済み |
bl team update <id> | PATCH /api/v2/teams/{teamId} | ✅ 実装済み |
bl team delete <id> | DELETE /api/v2/teams/{teamId} | ✅ 実装済み |
bl team icon <id> | GET /api/v2/teams/{teamId}/icon | ✅ 実装済み |
System
| コマンド | API エンドポイント | 状態 |
|---|---|---|
bl rate-limit | GET /api/v2/rateLimit | ✅ 実装済み |