CLI を使い始める

issues

orc issues は、WorkspaceのIssueを作成し、状態・担当者・優先度・ProjectやInitiativeへの所属を更新するコマンドです。コメント・履歴・リアクション・関連Issueを確認し、個人の表示設定や保存ビューも管理できます。削除はソフトデリートで、復元操作に対応します。

実行には認証とWorkspaceの選択が必要です。更新時は現在のIssueから取得した version を指定してください。Projectの関連付けに使用する project_id はUUIDで、Projectの検索キーとは異なります。

使い方

terminal
orc issues list --json

WorkspaceのIssueを一覧にします。

サブコマンド

list

状態、優先度、分類、Project、マイルストーン、Initiative、担当者、ラベルや検索語で絞り込みます。指定を省略した条件では対象を制限しません。並び順や完了済み・子Issueの扱いも指定できます。

terminal
orc issues list [options]

固有のオプション

--state

Filter by exact workflow state. Omit to include all states.

型: string。任意。

terminal
orc issues list --state <value>
--priority

Filter by exact priority. Omit to include all priorities and unprioritized issues.

型: string。任意。

terminal
orc issues list --priority <value>
--classification

Filter by work classification. Omit to include all classifications.

型: string。任意。

terminal
orc issues list --classification <value>
--project-id

Filter by project UUID. Omit to include issues with or without a project.; max 500 chars

型: string。任意。

terminal
orc issues list --project-id <value>
--milestone-id

Filter by membership in this milestone. Omit to leave milestone membership unrestricted.; max 500 chars

型: string。任意。

terminal
orc issues list --milestone-id <value>
--initiative-id

Filter by initiative id. Omit to leave initiative assignment unrestricted.; max 500 chars

型: string。任意。

terminal
orc issues list --initiative-id <value>
--assignee-id

Filter by assigned member id. Omit to include assigned and unassigned issues.; max 500 chars

型: string。任意。

terminal
orc issues list --assignee-id <value>
--label

Require this exact label in the issue label list. Omit to leave labels unrestricted.; max 100 chars

型: string。任意。

terminal
orc issues list --label <value>
--query

Case-insensitive search across internal id, title, description and rationale. SQL LIKE wildcards % and _ are supported. Omit to disable text filtering.; max 500 chars

型: string。任意。

terminal
orc issues list --query <value>
--order-by

Sort field. Defaults to created. Reuse the same ordering and filters with next_cursor.

型: string。任意。

terminal
orc issues list --order-by <value>
--order-direction

Override sort direction and the id tie-breaker. Defaults to descending for created/updated and ascending for the other sort fields.; enum: asc|desc

型: string。任意。

terminal
orc issues list --order-direction <value>
--completed-by-recency

When true, place done, closed and duplicate issues after unfinished work, ordered by newest state transition first. Defaults to false.; enum: true|false

型: string。任意。

terminal
orc issues list --completed-by-recency <value>
--completed-window

Filter terminal issues by their latest state transition: day=24 hours, week=7 days, month=one calendar month. none excludes terminal issues; all or omission imposes no time window. Unfinished issues are unaffected.; enum: all|day|week|month|none

型: string。任意。

terminal
orc issues list --completed-window <value>
--show-sub-issues

Set false to exclude children of non-deleted parent issues. Omitted or true includes them.; enum: true|false

型: string。任意。

terminal
orc issues list --show-sub-issues <value>

create

title と classification を指定してIssueを作成します。タイトルは前後の空白を除いて保存され、最大500文字です。説明、状態、優先度や同じWorkspaceの所属を併せて指定できます。

terminal
orc issues create [options]

固有のオプション

--idempotency-key

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

terminal
orc issues create --idempotency-key <value>
--assignee-id

Active workspace member to assign. Omitted on create means unassigned; null clears the assignment on update.; (use "null" or "reset" to clear); max 500 chars

型: string。任意。

terminal
orc issues create --assignee-id <value>
--canonical-issue-id

Active canonical issue in the same workspace. Required for state duplicate; must not reference this issue. Null clears the reference only when the resulting state permits it.; (use "null" or "reset" to clear); max 500 chars

型: string。任意。

terminal
orc issues create --canonical-issue-id <value>
--classification

(required) Body field: classification

型: string。任意。

terminal
orc issues create --classification <value>
--description

Issue details. Omit on create for null; on update omit to retain the value or send null to clear.; max 10000 chars

型: string。任意。

terminal
orc issues create --description <value>
--due-date

Calendar due date in YYYY-MM-DD form. Omit on create for no due date; send null on update to clear it.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc issues create --due-date <value>
--initiative-id

Initiative id in the same workspace. Omit on create for no initiative; send null on update to remove it.; (use "null" or "reset" to clear); max 500 chars

型: string。任意。

terminal
orc issues create --initiative-id <value>
--labels

Unique labels after trimming. Defaults to [] on create. On update replaces all labels; [] clears them.; csv

型: string。任意。

terminal
orc issues create --labels <value>
--observation-ref

Body field: observation_ref

型: string。任意。

terminal
orc issues create --observation-ref <value>
--priority

Priority, or null for no priority. Omitted on create means null; omitted on update leaves it unchanged.; enum: urgent|high|medium|low|; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc issues create --priority <value>
--project-id

Project UUID in the same workspace. Omit on create for no project; send null on update to remove it.; (use "null" or "reset" to clear); max 500 chars

型: string。任意。

terminal
orc issues create --project-id <value>
--rationale

Reason for this issue. Defaults to the trimmed title on create; omit on update to retain it.; max 10000 chars

型: string。任意。

terminal
orc issues create --rationale <value>
--state

Body field: state

型: string。任意。

terminal
orc issues create --state <value>
--target-entity-ref

Body field: target_entity_ref

型: string。任意。

terminal
orc issues create --target-entity-ref <value>
--title

(required) Short issue title, trimmed before storage.; max 500 chars

型: string。任意。

terminal
orc issues create --title <value>

get

Issue IDを指定して現在の情報を取得します。更新に使用する version はこの応答から取得します。

terminal
orc issues get <id> [options]

update

Issue IDと現在の version を指定して内容を更新します。古いバージョンでは 409 version_conflict が返ります。省略した説明や所属は保持し、解除に対応する項目は null で解除できます。

terminal
orc issues update <id> [options]

固有のオプション

--assignee-id

Active workspace member to assign. Omitted on create means unassigned; null clears the assignment on update.; (use "null" or "reset" to clear); max 500 chars

型: string。任意。

terminal
orc issues update <id> --assignee-id <value>
--canonical-issue-id

Active canonical issue in the same workspace. Required for state duplicate; must not reference this issue. Null clears the reference only when the resulting state permits it.; (use "null" or "reset" to clear); max 500 chars

型: string。任意。

terminal
orc issues update <id> --canonical-issue-id <value>
--classification

Body field: classification

型: string。任意。

terminal
orc issues update <id> --classification <value>
--description

Issue details. Omit on create for null; on update omit to retain the value or send null to clear.; (use "null" or "reset" to clear); max 10000 chars

型: string。任意。

terminal
orc issues update <id> --description <value>
--due-date

Calendar due date in YYYY-MM-DD form. Omit on create for no due date; send null on update to clear it.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc issues update <id> --due-date <value>
--initiative-id

Initiative id in the same workspace. Omit on create for no initiative; send null on update to remove it.; (use "null" or "reset" to clear); max 500 chars

型: string。任意。

terminal
orc issues update <id> --initiative-id <value>
--labels

Unique labels after trimming. Defaults to [] on create. On update replaces all labels; [] clears them.; csv

型: string。任意。

terminal
orc issues update <id> --labels <value>
--observation-ref

Body field: observation_ref

型: string。任意。

terminal
orc issues update <id> --observation-ref <value>
--priority

Priority, or null for no priority. Omitted on create means null; omitted on update leaves it unchanged.; enum: urgent|high|medium|low|; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc issues update <id> --priority <value>
--project-id

Project UUID in the same workspace. Omit on create for no project; send null on update to remove it.; (use "null" or "reset" to clear); max 500 chars

型: string。任意。

terminal
orc issues update <id> --project-id <value>
--rank

Non-negative decimal string for the workspace-shared manual order. Omit to retain the current rank.; max 100 chars

型: string。任意。

terminal
orc issues update <id> --rank <value>
--rationale

Reason for this issue. Defaults to the trimmed title on create; omit on update to retain it.; max 10000 chars

型: string。任意。

terminal
orc issues update <id> --rationale <value>
--state

Body field: state

型: string。任意。

terminal
orc issues update <id> --state <value>
--target-entity-ref

Body field: target_entity_ref

型: string。任意。

terminal
orc issues update <id> --target-entity-ref <value>
--title

Short issue title, trimmed before storage.; max 500 chars

型: string。任意。

terminal
orc issues update <id> --title <value>
--version

(required) Version read from the current Issue. A stale version returns 409 version_conflict.

型: number。任意。

terminal
orc issues update <id> --version <value>

delete

Issue IDを指定してソフトデリートします。復元する場合は restore を使用します。

terminal
orc issues delete <id> [options]

activity list

Issueの変更履歴を一覧にします。--limit と --cursor でページを指定します。

terminal
orc issues activity list <id> [options]

comments list

Issueのコメントを一覧にします。--limit と --cursor でページを指定します。

terminal
orc issues comments list <id> [options]

comments create

Issue IDと body を指定してコメントを投稿します。返信では parent_id を指定できます。

terminal
orc issues comments create <id> [options]

固有のオプション

--body

(required) Comment text, trimmed before storage.; max 10000 chars

型: string。任意。

terminal
orc issues comments create <id> --body <value>
--parent-id

Top-level comment id on this issue to reply to. Omit or null for a new top-level comment. Replies to replies are rejected with 422.; (use "null" or "reset" to clear); max 500 chars

型: string。任意。

terminal
orc issues comments create <id> --parent-id <value>

favorites enable

指定したIssueをお気に入りに追加します。

terminal
orc issues favorites enable <id> [options]

favorites disable

指定したIssueをお気に入りから外します。

terminal
orc issues favorites disable <id> [options]

reactions list

Issueのリアクションを一覧にします。

terminal
orc issues reactions list <id> [options]

reactions create

Issue IDと emoji を指定してリアクションを追加します。コメントへのリアクションでは comment_id を指定します。

terminal
orc issues reactions create <id> [options]

固有のオプション

--comment-id

Comment on the same issue to react to. Omit or null to react to the issue itself.; (use "null" or "reset" to clear); max 500 chars

型: string。任意。

terminal
orc issues reactions create <id> --comment-id <value>
--emoji

(required) Reaction text, trimmed before storage.; max 64 chars

型: string。任意。

terminal
orc issues reactions create <id> --emoji <value>

reactions delete

Issue IDと絵文字を指定してリアクションを除外します。コメントが対象の場合は --comment-id も指定します。

terminal
orc issues reactions delete <id> <emoji> [options]

固有のオプション

--comment-id

Comment id on this issue. Omit to remove the reaction on the issue body.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc issues reactions delete <id> <emoji> --comment-id <value>

restore

ソフトデリートしたIssueをIDで指定して復元します。

terminal
orc issues restore <id> [options]

subscriptions enable

指定したIssueを購読します。

terminal
orc issues subscriptions enable <id> [options]

subscriptions disable

指定したIssueの購読を解除します。

terminal
orc issues subscriptions disable <id> [options]

preferences get

本人のIssue表示設定を取得します。Issueそのものの設定や共有ビューとは別です。

terminal
orc issues preferences get [options]

preferences update

フィルター、グループ分け、レイアウト、並び順などの個人設定を保存します。完全な設定リソースを --stdin で送信できます。

terminal
orc issues preferences update [options]

固有のオプション

--completed-by-recency

(required) Whether completed issues follow unfinished issues in newest-transition order.

型: string。任意。

terminal
orc issues preferences update --completed-by-recency <value>
--completed-window

Saved terminal-issue time window: all, day, week, month or none.; enum: all|day|week|month|none

型: string。任意。

terminal
orc issues preferences update --completed-window <value>
--display-properties

(required) Ordered list of issue properties to display. Values must be unique. An empty array saves no optional display properties.; csv of: id|status|assignee|priority|project|initiative|labels|created|updated|dueDate|timeInStatus

型: string。任意。

terminal
orc issues preferences update --display-properties <value>
--filter

(required) Body field: filter

型: string。任意。

terminal
orc issues preferences update --filter <value>
--grouping

(required) Body field: grouping

型: string。任意。

terminal
orc issues preferences update --grouping <value>
--grouping-direction

Optional saved group ordering direction.; enum: asc|desc

型: string。任意。

terminal
orc issues preferences update --grouping-direction <value>
--layout

(required) Body field: layout

型: string。任意。

terminal
orc issues preferences update --layout <value>
--ordering

(required) Body field: ordering

型: string。任意。

terminal
orc issues preferences update --ordering <value>
--ordering-direction

Optional saved issue sort direction.; enum: asc|desc

型: string。任意。

terminal
orc issues preferences update --ordering-direction <value>
--show-completed

(required) Whether the view displays completed issues.

型: string。任意。

terminal
orc issues preferences update --show-completed <value>
--show-empty-columns

(required) Whether the view displays empty groups or board columns.

型: string。任意。

terminal
orc issues preferences update --show-empty-columns <value>
--show-sub-issues

Saved option controlling whether child issues are shown.

型: string。任意。

terminal
orc issues preferences update --show-sub-issues <value>

views list

現在の認証主体が参照できるIssueViewを一覧にします。

terminal
orc issues views list [options]

views create

名前、公開範囲、フィルター、グループ分け、レイアウト、並び順を指定してIssueViewを作成します。クエリーフィルターのみの saved-views とは別のリソースです。

terminal
orc issues views create [options]

固有のオプション

--completed-by-recency

(required) Whether completed issues follow unfinished issues in newest-transition order.

型: string。任意。

terminal
orc issues views create --completed-by-recency <value>
--completed-window

Saved terminal-issue time window: all, day, week, month or none.; enum: all|day|week|month|none

型: string。任意。

terminal
orc issues views create --completed-window <value>
--display-properties

(required) Ordered list of issue properties to display. Values must be unique. An empty array saves no optional display properties.; csv of: id|status|assignee|priority|project|initiative|labels|created|updated|dueDate|timeInStatus

型: string。任意。

terminal
orc issues views create --display-properties <value>
--filter

(required) Body field: filter

型: string。任意。

terminal
orc issues views create --filter <value>
--grouping

(required) Body field: grouping

型: string。任意。

terminal
orc issues views create --grouping <value>
--grouping-direction

Optional saved group ordering direction.; enum: asc|desc

型: string。任意。

terminal
orc issues views create --grouping-direction <value>
--layout

(required) Body field: layout

型: string。任意。

terminal
orc issues views create --layout <value>
--name

(required) Display name for the saved view.; max 200 chars

型: string。任意。

terminal
orc issues views create --name <value>
--ordering

(required) Body field: ordering

型: string。任意。

terminal
orc issues views create --ordering <value>
--ordering-direction

Optional saved issue sort direction.; enum: asc|desc

型: string。任意。

terminal
orc issues views create --ordering-direction <value>
--show-completed

(required) Whether the view displays completed issues.

型: string。任意。

terminal
orc issues views create --show-completed <value>
--show-empty-columns

(required) Whether the view displays empty groups or board columns.

型: string。任意。

terminal
orc issues views create --show-empty-columns <value>
--show-sub-issues

Saved option controlling whether child issues are shown.

型: string。任意。

terminal
orc issues views create --show-sub-issues <value>
--visibility

(required) Body field: visibility

型: string。任意。

terminal
orc issues views create --visibility <value>

views get

ビューIDを指定してIssueViewを取得します。

terminal
orc issues views get <id> [options]

views update

ビューIDを指定し、名前やフィルター、レイアウトなどを更新します。フィルターは省略すると保持し、null で解除します。

terminal
orc issues views update <id> [options]

固有のオプション

--completed-by-recency

Replacement completion ordering option. Omit to retain it.

型: string。任意。

terminal
orc issues views update <id> --completed-by-recency <value>
--completed-window

Saved terminal-issue time window: all, day, week, month or none.; enum: all|day|week|month|none

型: string。任意。

terminal
orc issues views update <id> --completed-window <value>
--display-properties

Replacement ordered display-property list. Values must be unique. Omit to retain the current list; send an empty array to clear it.; csv of: id|status|assignee|priority|project|initiative|labels|created|updated|dueDate|timeInStatus

型: string。任意。

terminal
orc issues views update <id> --display-properties <value>
--filter

Replacement filter conjunction. Null clears the filter; omission retains it.; (JSON object, e.g. '{"custom_id":"x"}'); (use "null" or "reset" to clear)

型: string。任意。

terminal
orc issues views update <id> --filter <value>
--grouping

Body field: grouping

型: string。任意。

terminal
orc issues views update <id> --grouping <value>
--grouping-direction

Optional saved group ordering direction.; enum: asc|desc

型: string。任意。

terminal
orc issues views update <id> --grouping-direction <value>
--layout

Body field: layout

型: string。任意。

terminal
orc issues views update <id> --layout <value>
--name

Replacement display name. Omit to retain it.; max 200 chars

型: string。任意。

terminal
orc issues views update <id> --name <value>
--ordering

Body field: ordering

型: string。任意。

terminal
orc issues views update <id> --ordering <value>
--ordering-direction

Optional saved issue sort direction.; enum: asc|desc

型: string。任意。

terminal
orc issues views update <id> --ordering-direction <value>
--show-completed

Replacement completed-issue visibility. Omit to retain it.

型: string。任意。

terminal
orc issues views update <id> --show-completed <value>
--show-empty-columns

Replacement empty-column visibility. Omit to retain it.

型: string。任意。

terminal
orc issues views update <id> --show-empty-columns <value>
--show-sub-issues

Saved option controlling whether child issues are shown.

型: string。任意。

terminal
orc issues views update <id> --show-sub-issues <value>

views delete

ビューIDを指定してIssueViewを削除します。

terminal
orc issues views delete <id> [options]

views defaults enable

ビューIDと scope を指定して既定ビューに設定します。personal は本人だけに適用し、workspace は共有既定値を変更するためWorkspace owner権限が必要です。

terminal
orc issues views defaults enable <id> [options]

固有のオプション

--scope

(required) personal changes only your default view. workspace changes the shared default and requires workspace owner permission.; enum: personal|workspace

型: string。任意。

terminal
orc issues views defaults enable <id> --scope <value>

views defaults disable

ビューIDと scope を指定して既定ビューを解除します。personal と workspace の権限範囲は設定時と同じです。

terminal
orc issues views defaults disable <id> [options]

固有のオプション

--scope

(required) personal changes only your default view. workspace changes the shared default and requires workspace owner permission.; enum: personal|workspace

型: string。任意。

terminal
orc issues views defaults disable <id> --scope <value>

relations list

指定したIssueの関連Issueを一覧にします。

terminal
orc issues relations list <id> [options]

relations create

同じWorkspaceの別の有効なIssueを related_issue_id に指定し、type を指定して関連付けます。自分自身を関連先にはできません。

terminal
orc issues relations create <id> [options]

固有のオプション

(required) Other active issue in the same workspace. Must not be the source issue.; max 500 chars

型: string。任意。

terminal
orc issues relations create <id> --related-issue-id <value>
--type

(required) Body field: type

型: string。任意。

terminal
orc issues relations create <id> --type <value>

relations delete

Issue IDと関係IDを指定して関連付けを解除します。

terminal
orc issues relations delete <id> <relation-id> [options]

batch update

JSONの items に複数の操作を指定して実行します。各項目を入力順に独立して処理し、応答のindexは入力配列に対応します。個別の失敗は成功済みの操作をロールバックしません。

terminal
orc issues batch update [options]

固有のオプション

--idempotency-key

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

terminal
orc issues batch update --idempotency-key <value>
--items

(required) Actions processed independently in input order. Each result index refers to this array. A malformed request is rejected before processing; reported item failures do not roll back successful items.; JSON array of objects (use --stdin for large resources)

型: string。任意。

terminal
orc issues batch update --items <value>

使用例

ProjectのUUIDでIssueを絞り込みます。

terminal
orc issues list --project-id PROJECT_ID --json

ProjectのUUIDでIssueを絞り込みます。

現在のIssueを取得して更新用ファイルを送信します。

更新ファイルには取得した version と変更する項目を含めてください。

terminal
orc issues get ISSUE_ID --json
orc issues update ISSUE_ID --stdin < issue-update.json --json

現在のIssueを取得して更新用ファイルを送信します。

Issueにコメントを投稿します。

terminal
orc issues comments create ISSUE_ID --body "Checked the reproduction steps." --json

Issueにコメントを投稿します。

自分の既定ビューを設定します。

terminal
orc issues views defaults enable VIEW_ID --scope personal --json

自分の既定ビューを設定します。

競合と一括操作

更新で 409 version_conflict が返った場合は、get で現在の内容と version を読み直し、必要な変更を確認して再送します。古いバージョンのまま再試行しないでください。

一括操作の不正なリクエストは処理前に拒否されますが、処理が始まった後の個別エラーは部分成功になります。応答の各indexと結果を確認し、成功した項目を重複実行しないようにしてください。

グローバルオプション

orc issues では、次のグローバルオプションを使用できます。

各オプションの詳細と使用例は、グローバルオプションを参照してください。