CLI を使い始める

issues

@orchestor-inc/cli のコマンドリファレンスです。

コマンド一覧

  • orc issues list — List Issues
  • orc issues create — Create an Issue
  • orc issues get — Get an Issue
  • orc issues update — Update an Issue
  • orc issues delete — Soft-delete an Issue
  • orc issues activity list — List Issue activity
  • orc issues comments list — List Issue comments
  • orc issues comments create — Comment on an Issue
  • orc issues favorites enable — Favorite an Issue
  • orc issues favorites disable — Unfavorite an Issue
  • orc issues reactions list — List Issue reactions
  • orc issues reactions create — React to an Issue
  • orc issues reactions delete — Remove an Issue reaction
  • orc issues restore — Restore an Issue
  • orc issues subscriptions enable — Subscribe to an Issue
  • orc issues subscriptions disable — Unsubscribe from an Issue
  • orc issues preferences get — Get personal Issue preferences
  • orc issues preferences update — Save personal Issue preferences
  • orc issues views list — List visible IssueViews
  • orc issues views create — Create an IssueView
  • orc issues views get — Get an IssueView
  • orc issues views update — Update an IssueView
  • orc issues views delete — Delete an IssueView
  • orc issues views defaults enable — Set an IssueView default
  • orc issues views defaults disable — Clear an IssueView default
  • orc issues relations list — List Issue relations
  • orc issues relations create — Create an Issue relation
  • orc issues relations delete — Delete an Issue relation
  • orc issues batch update — Batch Issue operations

orc issues list

List Issues

構文

orc issues list [flags]

フラグ

フラグ型必須説明
--statestringいいえenum: triage|backlog|in_progress|in_review|done|closed|duplicate
--prioritystringいいえenum: urgent|high|medium|low
--classificationstringいいえenum: owned|earned|community
--project-idstringいいえmax 500 chars
--initiative-idstringいいえmax 500 chars
--assignee-idstringいいえmax 500 chars
--labelstringいいえmax 100 chars
--querystringいいえmax 500 chars
--order-bystringいいえenum: title|priority|updated|created|manual
--limitnumberいいえMaximum number of items to return
--cursorstringいいえOpaque cursor for the next page

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue list

ヘルプ

orc issues list --help

orc issues create

Create an Issue

構文

orc issues create [flags]

フラグ

フラグ型必須説明
--idempotency-keystringいいえUnique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns 409 idempotency_error. Use a UUID v4 or similar unique identifier.
--assignee-idstringいいえBody field: assignee_id; max 500 chars
--canonical-issue-idstringいいえBody field: canonical_issue_id; max 500 chars
--classificationstringいいえ(required) Body field: classification; enum: owned|earned|community
--descriptionstringいいえBody field: description; max 10000 chars
--due-datestringいいえBody field: due_date
--initiative-idstringいいえBody field: initiative_id; max 500 chars
--labelsstringいいえBody field: labels; csv
--observation-refstringいいえBody field: observation_ref; (JSON object, e.g. '{"custom_id":"x"}')
--prioritystringいいえBody field: priority; enum: urgent|high|medium|low|
--project-idstringいいえBody field: project_id; max 500 chars
--rationalestringいいえBody field: rationale; max 10000 chars
--statestringいいえBody field: state; enum: triage|backlog|in_progress|in_review|done|closed|duplicate
--target-entity-refstringいいえBody field: target_entity_ref; (JSON object, e.g. '{"custom_id":"x"}')
--titlestringいいえ(required) Body field: title; max 500 chars

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue create

ヘルプ

orc issues create --help

orc issues get

Get an Issue

構文

orc issues get <id> [flags]

引数

引数必須説明
idはいPath parameter: id

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue get

ヘルプ

orc issues get --help

orc issues update

Update an Issue

構文

orc issues update <id> [flags]

引数

引数必須説明
idはいPath parameter: id

フラグ

フラグ型必須説明
--assignee-idstringいいえBody field: assignee_id; max 500 chars
--canonical-issue-idstringいいえBody field: canonical_issue_id; max 500 chars
--classificationstringいいえBody field: classification; enum: owned|earned|community
--descriptionstringいいえBody field: description; max 10000 chars
--due-datestringいいえBody field: due_date
--initiative-idstringいいえBody field: initiative_id; max 500 chars
--labelsstringいいえBody field: labels; csv
--observation-refstringいいえBody field: observation_ref; (JSON object, e.g. '{"custom_id":"x"}')
--prioritystringいいえBody field: priority; enum: urgent|high|medium|low|
--project-idstringいいえBody field: project_id; max 500 chars
--rankstringいいえBody field: rank; max 100 chars
--rationalestringいいえBody field: rationale; max 10000 chars
--statestringいいえBody field: state; enum: triage|backlog|in_progress|in_review|done|closed|duplicate
--target-entity-refstringいいえBody field: target_entity_ref; (JSON object, e.g. '{"custom_id":"x"}')
--titlestringいいえBody field: title; max 500 chars
--versionnumberいいえ(required) Body field: version

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue update

ヘルプ

orc issues update --help

orc issues delete

Soft-delete an Issue

構文

orc issues delete <id> [flags]

引数

引数必須説明
idはいPath parameter: id

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue delete

ヘルプ

orc issues delete --help

orc issues activity list

List Issue activity

構文

orc issues activity list <id> [flags]

引数

引数必須説明
idはいPath parameter: id

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue activity

ヘルプ

orc issues activity list --help

orc issues comments list

List Issue comments

構文

orc issues comments list <id> [flags]

引数

引数必須説明
idはいPath parameter: id

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue comments

ヘルプ

orc issues comments list --help

orc issues comments create

Comment on an Issue

構文

orc issues comments create <id> [flags]

引数

引数必須説明
idはいPath parameter: id

フラグ

フラグ型必須説明
--bodystringいいえ(required) Body field: body; max 10000 chars
--parent-idstringいいえBody field: parent_id; max 500 chars

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue comment

ヘルプ

orc issues comments create --help

orc issues favorites enable

Favorite an Issue

構文

orc issues favorites enable <id> [flags]

引数

引数必須説明
idはいPath parameter: id

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue favorite

ヘルプ

orc issues favorites enable --help

orc issues favorites disable

Unfavorite an Issue

構文

orc issues favorites disable <id> [flags]

引数

引数必須説明
idはいPath parameter: id

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue unfavorite

ヘルプ

orc issues favorites disable --help

orc issues reactions list

List Issue reactions

構文

orc issues reactions list <id> [flags]

引数

引数必須説明
idはいPath parameter: id

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue reactions

ヘルプ

orc issues reactions list --help

orc issues reactions create

React to an Issue

構文

orc issues reactions create <id> [flags]

引数

引数必須説明
idはいPath parameter: id

フラグ

フラグ型必須説明
--comment-idstringいいえBody field: comment_id; max 500 chars
--emojistringいいえ(required) Body field: emoji; max 64 chars

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue react

ヘルプ

orc issues reactions create --help

orc issues reactions delete

Remove an Issue reaction

構文

orc issues reactions delete <id> <emoji> [flags]

引数

引数必須説明
idはいPath parameter: id
emojiはいPath parameter: emoji

フラグ

フラグ型必須説明
--comment-idstringいいえ(use "null" or "reset" to clear)

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue unreact

ヘルプ

orc issues reactions delete --help

orc issues restore

Restore an Issue

構文

orc issues restore <id> [flags]

引数

引数必須説明
idはいPath parameter: id

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue restore

ヘルプ

orc issues restore --help

orc issues subscriptions enable

Subscribe to an Issue

構文

orc issues subscriptions enable <id> [flags]

引数

引数必須説明
idはいPath parameter: id

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue subscribe

ヘルプ

orc issues subscriptions enable --help

orc issues subscriptions disable

Unsubscribe from an Issue

構文

orc issues subscriptions disable <id> [flags]

引数

引数必須説明
idはいPath parameter: id

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue unsubscribe

ヘルプ

orc issues subscriptions disable --help

orc issues preferences get

Get personal Issue preferences

構文

orc issues preferences get [flags]

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc issues preferences get --help

orc issues preferences update

Save personal Issue preferences

構文

orc issues preferences update [flags]

フラグ

フラグ型必須説明
--completed-by-recencystringいいえ(required) Body field: completed_by_recency
--display-propertiesstringいいえ(required) Body field: display_properties; csv of: id|status|assignee|priority|project|initiative|labels|created|updated
--filterstringいいえ(required) Body field: filter
--groupingstringいいえ(required) Body field: grouping; enum: status|classification|assignee|project|priority|label
--layoutstringいいえ(required) Body field: layout; enum: list|board
--orderingstringいいえ(required) Body field: ordering; enum: title|priority|updated|created|manual
--show-completedstringいいえ(required) Body field: show_completed
--show-empty-columnsstringいいえ(required) Body field: show_empty_columns

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc issues preferences update --help

orc issues views list

List visible IssueViews

構文

orc issues views list [flags]

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc issues views list --help

orc issues views create

Create an IssueView

構文

orc issues views create [flags]

フラグ

フラグ型必須説明
--completed-by-recencystringいいえ(required) Body field: completed_by_recency
--display-propertiesstringいいえ(required) Body field: display_properties; csv of: id|status|assignee|priority|project|initiative|labels|created|updated
--filterstringいいえ(required) Body field: filter
--groupingstringいいえ(required) Body field: grouping; enum: status|classification|assignee|project|priority|label
--layoutstringいいえ(required) Body field: layout; enum: list|board
--namestringいいえ(required) Body field: name; max 200 chars
--orderingstringいいえ(required) Body field: ordering; enum: title|priority|updated|created|manual
--show-completedstringいいえ(required) Body field: show_completed
--show-empty-columnsstringいいえ(required) Body field: show_empty_columns
--visibilitystringいいえ(required) Body field: visibility; enum: personal|workspace

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc issues views create --help

orc issues views get

Get an IssueView

構文

orc issues views get <id> [flags]

引数

引数必須説明
idはいPath parameter: id

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc issues views get --help

orc issues views update

Update an IssueView

構文

orc issues views update <id> [flags]

引数

引数必須説明
idはいPath parameter: id

フラグ

フラグ型必須説明
--completed-by-recencystringいいえBody field: completed_by_recency
--display-propertiesstringいいえBody field: display_properties; csv of: id|status|assignee|priority|project|initiative|labels|created|updated
--filterstringいいえBody field: filter
--groupingstringいいえBody field: grouping; enum: status|classification|assignee|project|priority|label
--layoutstringいいえBody field: layout; enum: list|board
--namestringいいえBody field: name; max 200 chars
--orderingstringいいえBody field: ordering; enum: title|priority|updated|created|manual
--show-completedstringいいえBody field: show_completed
--show-empty-columnsstringいいえBody field: show_empty_columns

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc issues views update --help

orc issues views delete

Delete an IssueView

構文

orc issues views delete <id> [flags]

引数

引数必須説明
idはいPath parameter: id

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc issues views delete --help

orc issues views defaults enable

Set an IssueView default

構文

orc issues views defaults enable <id> [flags]

引数

引数必須説明
idはいPath parameter: id

フラグ

フラグ型必須説明
--scopestringいいえ(required) Body field: scope; enum: personal|workspace

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc issues views defaults enable --help

orc issues views defaults disable

Clear an IssueView default

構文

orc issues views defaults disable <id> [flags]

引数

引数必須説明
idはいPath parameter: id

フラグ

フラグ型必須説明
--scopestringいいえ(required) Body field: scope; enum: personal|workspace

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc issues views defaults disable --help

orc issues relations list

List Issue relations

構文

orc issues relations list <id> [flags]

引数

引数必須説明
idはいPath parameter: id

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue relations

ヘルプ

orc issues relations list --help

orc issues relations create

Create an Issue relation

構文

orc issues relations create <id> [flags]

引数

引数必須説明
idはいPath parameter: id

フラグ

フラグ型必須説明
--related-issue-idstringいいえ(required) Body field: related_issue_id; max 500 chars
--typestringいいえ(required) Body field: type; enum: related|blocking|duplicate|parent

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue relate

ヘルプ

orc issues relations create --help

orc issues relations delete

Delete an Issue relation

構文

orc issues relations delete <id> <relation-id> [flags]

引数

引数必須説明
idはいPath parameter: id
relation-idはいPath parameter: relation_id

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue unrelate

ヘルプ

orc issues relations delete --help

orc issues batch update

Batch Issue operations

構文

orc issues batch update [flags]

フラグ

フラグ型必須説明
--idempotency-keystringいいえUnique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns 409 idempotency_error. Use a UUID v4 or similar unique identifier.
--itemsstringいいえ(required) Body field: items; JSON array of objects (use --stdin for large resources)

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

  • orc issue batch-update

ヘルプ

orc issues batch update --help