Getting started

initiatives

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

Commands

  • orc initiatives list — List workspace initiatives
  • orc initiatives create — Create a workspace initiative
  • orc initiatives get — Get an initiative
  • orc initiatives update — Update an initiative
  • orc initiatives delete — Soft-delete an Initiative
  • orc initiatives rollup get — Get initiative progress rollup
  • orc initiatives projects list — List Initiative Projects
  • orc initiatives projects create — Add a Project to an Initiative
  • orc initiatives projects update — Reorder an Initiative Project
  • orc initiatives projects delete — Remove a Project from an Initiative
  • orc initiatives activity list — List Initiative activity
  • orc initiatives comments list — List Initiative comments
  • orc initiatives comments create — Comment on an Initiative
  • orc initiatives favorites enable — Favorite an Initiative
  • orc initiatives favorites disable — Unfavorite an Initiative
  • orc initiatives restore — Restore an Initiative
  • orc initiatives subscriptions enable — Subscribe to an Initiative
  • orc initiatives subscriptions disable — Unsubscribe from an Initiative
  • orc initiatives updates list — List Initiative Updates
  • orc initiatives updates create — Post an Initiative Update
  • orc initiatives batch update — Batch update Initiatives

orc initiatives list

List workspace initiatives

Usage

orc initiatives list [flags]

Flags

FlagTypeRequiredDescription
--tabstringNoenum: active|planned|all
--statusstringNoenum: proposed|planned|active|completed|canceled
--sortstringNoenum: created_at|target_date|manual
--orderstringNoenum: asc|desc
--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.

Help

orc initiatives list --help

orc initiatives create

Create a workspace initiative

Usage

orc initiatives 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.
--colorstringNoBody field: color; max 100 chars
--descriptionstringNoBody field: description; max 2000 chars
--iconstringNoBody field: icon; max 100 chars
--labelsstringNoBody field: labels; csv
--namestringNo(required) Body field: name; max 200 chars
--owner-idstringNoBody field: owner_id
--prioritystringNoBody field: priority; enum: urgent|high|medium|low|
--statusstringNoBody field: status; enum: proposed|planned|active|completed|canceled
--target-datestringNoBody field: target_date
--target-precisionstringNoBody field: target_precision; enum: day|month|quarter|half_year|year|

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

Help

orc initiatives create --help

orc initiatives get

Get an initiative

Usage

orc initiatives get <id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative ID.

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

Help

orc initiatives get --help

orc initiatives update

Update an initiative

Usage

orc initiatives update <id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative ID.

Flags

FlagTypeRequiredDescription
--colorstringNoBody field: color; max 100 chars
--descriptionstringNoBody field: description; max 2000 chars
--iconstringNoBody field: icon; max 100 chars
--labelsstringNoBody field: labels; csv
--namestringNoBody field: name; max 200 chars
--owner-idstringNoBody field: owner_id
--prioritystringNoBody field: priority; enum: urgent|high|medium|low|
--rankstringNoBody field: rank; max 100 chars
--statusstringNoBody field: status; enum: proposed|planned|active|completed|canceled
--target-datestringNoBody field: target_date
--target-precisionstringNoBody field: target_precision; enum: day|month|quarter|half_year|year|
--versionnumberNo(required) Body field: version

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

Help

orc initiatives update --help

orc initiatives delete

Soft-delete an Initiative

Usage

orc initiatives delete <id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative ID.

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

Compatibility aliases

  • orc initiative delete

Help

orc initiatives delete --help

orc initiatives rollup get

Get initiative progress rollup

Usage

orc initiatives rollup get <id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative ID.

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

Help

orc initiatives rollup get --help

orc initiatives projects list

List Initiative Projects

Usage

orc initiatives projects list <id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative ID.

Flags

FlagTypeRequiredDescription
--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.

Help

orc initiatives projects list --help

orc initiatives projects create

Add a Project to an Initiative

Usage

orc initiatives projects create <id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative ID.

Flags

FlagTypeRequiredDescription
--project-idstringNo(required) Body field: project_id
--ranknumberNoBody field: rank

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

Compatibility aliases

  • orc initiatives projects add

Help

orc initiatives projects create --help

orc initiatives projects update

Reorder an Initiative Project

Usage

orc initiatives projects update <id> <project-id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative ID.
project-idYesProject ID.

Flags

FlagTypeRequiredDescription
--ranknumberNo(required) Body field: rank

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

Compatibility aliases

  • orc initiatives projects reorder

Help

orc initiatives projects update --help

orc initiatives projects delete

Remove a Project from an Initiative

Usage

orc initiatives projects delete <id> <project-id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative ID.
project-idYesProject ID.

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

Compatibility aliases

  • orc initiatives projects remove

Help

orc initiatives projects delete --help

orc initiatives activity list

List Initiative activity

Usage

orc initiatives activity list <id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative ID.

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

Compatibility aliases

  • orc initiative activity

Help

orc initiatives activity list --help

orc initiatives comments list

List Initiative comments

Usage

orc initiatives comments list <id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative ID.

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

Compatibility aliases

  • orc initiative comments

Help

orc initiatives comments list --help

orc initiatives comments create

Comment on an Initiative

Usage

orc initiatives comments create <id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative 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 initiative comment

Help

orc initiatives comments create --help

orc initiatives favorites enable

Favorite an Initiative

Usage

orc initiatives favorites enable <id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative ID.

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

Compatibility aliases

  • orc initiative favorite

Help

orc initiatives favorites enable --help

orc initiatives favorites disable

Unfavorite an Initiative

Usage

orc initiatives favorites disable <id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative ID.

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

Compatibility aliases

  • orc initiative unfavorite

Help

orc initiatives favorites disable --help

orc initiatives restore

Restore an Initiative

Usage

orc initiatives restore <id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative ID.

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

Compatibility aliases

  • orc initiative restore

Help

orc initiatives restore --help

orc initiatives subscriptions enable

Subscribe to an Initiative

Usage

orc initiatives subscriptions enable <id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative ID.

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

Compatibility aliases

  • orc initiative subscribe

Help

orc initiatives subscriptions enable --help

orc initiatives subscriptions disable

Unsubscribe from an Initiative

Usage

orc initiatives subscriptions disable <id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative ID.

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

Compatibility aliases

  • orc initiative unsubscribe

Help

orc initiatives subscriptions disable --help

orc initiatives updates list

List Initiative Updates

Usage

orc initiatives updates list <id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative ID.

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

Compatibility aliases

  • orc initiative updates

Help

orc initiatives updates list --help

orc initiatives updates create

Post an Initiative Update

Usage

orc initiatives updates create <id> [flags]

Arguments

ArgumentRequiredDescription
idYesInitiative ID.

Flags

FlagTypeRequiredDescription
--bodystringNo(required) Body field: body; max 10000 chars
--healthstringNo(required) Body field: health; enum: on_track|at_risk|off_track

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

Compatibility aliases

  • orc initiative update

Help

orc initiatives updates create --help

orc initiatives batch update

Batch update Initiatives

Usage

orc initiatives 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.

Help

orc initiatives batch update --help