Getting started

issues

This page is the command reference for @orchestor-inc/cli.

Commands

  • 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

Usage

orc issues list [flags]

Flags

FlagTypeRequiredDescription
--statestringNoenum: triage|backlog|in_progress|in_review|done|closed|duplicate
--prioritystringNoenum: urgent|high|medium|low
--classificationstringNoenum: owned|earned|community
--project-idstringNomax 500 chars
--initiative-idstringNomax 500 chars
--assignee-idstringNomax 500 chars
--labelstringNomax 100 chars
--querystringNomax 500 chars
--order-bystringNoenum: title|priority|updated|created|manual
--limitnumberNoMaximum number of items to return
--cursorstringNoOpaque cursor for the next page

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue list

Help

orc issues list --help

orc issues create

Create an Issue

Usage

orc issues create [flags]

Flags

FlagTypeRequiredDescription
--idempotency-keystringNoUnique 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-idstringNoBody field: assignee_id; max 500 chars
--canonical-issue-idstringNoBody field: canonical_issue_id; max 500 chars
--classificationstringNo(required) Body field: classification; enum: owned|earned|community
--descriptionstringNoBody field: description; max 10000 chars
--due-datestringNoBody field: due_date
--initiative-idstringNoBody field: initiative_id; max 500 chars
--labelsstringNoBody field: labels; csv
--observation-refstringNoBody field: observation_ref; (JSON object, e.g. '{"custom_id":"x"}')
--prioritystringNoBody field: priority; enum: urgent|high|medium|low|
--project-idstringNoBody field: project_id; max 500 chars
--rationalestringNoBody field: rationale; max 10000 chars
--statestringNoBody field: state; enum: triage|backlog|in_progress|in_review|done|closed|duplicate
--target-entity-refstringNoBody field: target_entity_ref; (JSON object, e.g. '{"custom_id":"x"}')
--titlestringNo(required) Body field: title; max 500 chars

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue create

Help

orc issues create --help

orc issues get

Get an Issue

Usage

orc issues get <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue get

Help

orc issues get --help

orc issues update

Update an Issue

Usage

orc issues update <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

Flags

FlagTypeRequiredDescription
--assignee-idstringNoBody field: assignee_id; max 500 chars
--canonical-issue-idstringNoBody field: canonical_issue_id; max 500 chars
--classificationstringNoBody field: classification; enum: owned|earned|community
--descriptionstringNoBody field: description; max 10000 chars
--due-datestringNoBody field: due_date
--initiative-idstringNoBody field: initiative_id; max 500 chars
--labelsstringNoBody field: labels; csv
--observation-refstringNoBody field: observation_ref; (JSON object, e.g. '{"custom_id":"x"}')
--prioritystringNoBody field: priority; enum: urgent|high|medium|low|
--project-idstringNoBody field: project_id; max 500 chars
--rankstringNoBody field: rank; max 100 chars
--rationalestringNoBody field: rationale; max 10000 chars
--statestringNoBody field: state; enum: triage|backlog|in_progress|in_review|done|closed|duplicate
--target-entity-refstringNoBody field: target_entity_ref; (JSON object, e.g. '{"custom_id":"x"}')
--titlestringNoBody field: title; max 500 chars
--versionnumberNo(required) Body field: version

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue update

Help

orc issues update --help

orc issues delete

Soft-delete an Issue

Usage

orc issues delete <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue delete

Help

orc issues delete --help

orc issues activity list

List Issue activity

Usage

orc issues activity list <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue activity

Help

orc issues activity list --help

orc issues comments list

List Issue comments

Usage

orc issues comments list <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue comments

Help

orc issues comments list --help

orc issues comments create

Comment on an Issue

Usage

orc issues comments create <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

Flags

FlagTypeRequiredDescription
--bodystringNo(required) Body field: body; max 10000 chars
--parent-idstringNoBody field: parent_id; max 500 chars

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue comment

Help

orc issues comments create --help

orc issues favorites enable

Favorite an Issue

Usage

orc issues favorites enable <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue favorite

Help

orc issues favorites enable --help

orc issues favorites disable

Unfavorite an Issue

Usage

orc issues favorites disable <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue unfavorite

Help

orc issues favorites disable --help

orc issues reactions list

List Issue reactions

Usage

orc issues reactions list <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue reactions

Help

orc issues reactions list --help

orc issues reactions create

React to an Issue

Usage

orc issues reactions create <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

Flags

FlagTypeRequiredDescription
--comment-idstringNoBody field: comment_id; max 500 chars
--emojistringNo(required) Body field: emoji; max 64 chars

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue react

Help

orc issues reactions create --help

orc issues reactions delete

Remove an Issue reaction

Usage

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

Arguments

ArgumentRequiredDescription
idYesPath parameter: id
emojiYesPath parameter: emoji

Flags

FlagTypeRequiredDescription
--comment-idstringNo(use "null" or "reset" to clear)

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue unreact

Help

orc issues reactions delete --help

orc issues restore

Restore an Issue

Usage

orc issues restore <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue restore

Help

orc issues restore --help

orc issues subscriptions enable

Subscribe to an Issue

Usage

orc issues subscriptions enable <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue subscribe

Help

orc issues subscriptions enable --help

orc issues subscriptions disable

Unsubscribe from an Issue

Usage

orc issues subscriptions disable <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue unsubscribe

Help

orc issues subscriptions disable --help

orc issues preferences get

Get personal Issue preferences

Usage

orc issues preferences get [flags]

See global flags for output and request options. Use --help to check the flags supported by this command.

Help

orc issues preferences get --help

orc issues preferences update

Save personal Issue preferences

Usage

orc issues preferences update [flags]

Flags

FlagTypeRequiredDescription
--completed-by-recencystringNo(required) Body field: completed_by_recency
--display-propertiesstringNo(required) Body field: display_properties; csv of: id|status|assignee|priority|project|initiative|labels|created|updated
--filterstringNo(required) Body field: filter
--groupingstringNo(required) Body field: grouping; enum: status|classification|assignee|project|priority|label
--layoutstringNo(required) Body field: layout; enum: list|board
--orderingstringNo(required) Body field: ordering; enum: title|priority|updated|created|manual
--show-completedstringNo(required) Body field: show_completed
--show-empty-columnsstringNo(required) Body field: show_empty_columns

See global flags for output and request options. Use --help to check the flags supported by this command.

Help

orc issues preferences update --help

orc issues views list

List visible IssueViews

Usage

orc issues views list [flags]

See global flags for output and request options. Use --help to check the flags supported by this command.

Help

orc issues views list --help

orc issues views create

Create an IssueView

Usage

orc issues views create [flags]

Flags

FlagTypeRequiredDescription
--completed-by-recencystringNo(required) Body field: completed_by_recency
--display-propertiesstringNo(required) Body field: display_properties; csv of: id|status|assignee|priority|project|initiative|labels|created|updated
--filterstringNo(required) Body field: filter
--groupingstringNo(required) Body field: grouping; enum: status|classification|assignee|project|priority|label
--layoutstringNo(required) Body field: layout; enum: list|board
--namestringNo(required) Body field: name; max 200 chars
--orderingstringNo(required) Body field: ordering; enum: title|priority|updated|created|manual
--show-completedstringNo(required) Body field: show_completed
--show-empty-columnsstringNo(required) Body field: show_empty_columns
--visibilitystringNo(required) Body field: visibility; enum: personal|workspace

See global flags for output and request options. Use --help to check the flags supported by this command.

Help

orc issues views create --help

orc issues views get

Get an IssueView

Usage

orc issues views get <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

See global flags for output and request options. Use --help to check the flags supported by this command.

Help

orc issues views get --help

orc issues views update

Update an IssueView

Usage

orc issues views update <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

Flags

FlagTypeRequiredDescription
--completed-by-recencystringNoBody field: completed_by_recency
--display-propertiesstringNoBody field: display_properties; csv of: id|status|assignee|priority|project|initiative|labels|created|updated
--filterstringNoBody field: filter
--groupingstringNoBody field: grouping; enum: status|classification|assignee|project|priority|label
--layoutstringNoBody field: layout; enum: list|board
--namestringNoBody field: name; max 200 chars
--orderingstringNoBody field: ordering; enum: title|priority|updated|created|manual
--show-completedstringNoBody field: show_completed
--show-empty-columnsstringNoBody field: show_empty_columns

See global flags for output and request options. Use --help to check the flags supported by this command.

Help

orc issues views update --help

orc issues views delete

Delete an IssueView

Usage

orc issues views delete <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

See global flags for output and request options. Use --help to check the flags supported by this command.

Help

orc issues views delete --help

orc issues views defaults enable

Set an IssueView default

Usage

orc issues views defaults enable <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

Flags

FlagTypeRequiredDescription
--scopestringNo(required) Body field: scope; enum: personal|workspace

See global flags for output and request options. Use --help to check the flags supported by this command.

Help

orc issues views defaults enable --help

orc issues views defaults disable

Clear an IssueView default

Usage

orc issues views defaults disable <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

Flags

FlagTypeRequiredDescription
--scopestringNo(required) Body field: scope; enum: personal|workspace

See global flags for output and request options. Use --help to check the flags supported by this command.

Help

orc issues views defaults disable --help

orc issues relations list

List Issue relations

Usage

orc issues relations list <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue relations

Help

orc issues relations list --help

orc issues relations create

Create an Issue relation

Usage

orc issues relations create <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

Flags

FlagTypeRequiredDescription
--related-issue-idstringNo(required) Body field: related_issue_id; max 500 chars
--typestringNo(required) Body field: type; enum: related|blocking|duplicate|parent

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue relate

Help

orc issues relations create --help

orc issues relations delete

Delete an Issue relation

Usage

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

Arguments

ArgumentRequiredDescription
idYesPath parameter: id
relation-idYesPath parameter: relation_id

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue unrelate

Help

orc issues relations delete --help

orc issues batch update

Batch Issue operations

Usage

orc issues batch update [flags]

Flags

FlagTypeRequiredDescription
--idempotency-keystringNoUnique 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.
--itemsstringNo(required) Body field: items; JSON array of objects (use --stdin for large resources)

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

  • orc issue batch-update

Help

orc issues batch update --help