Getting started
projects
This page is the command reference for @orchestor-inc/cli.
Commands
orc projects list— List projectsorc projects create— Create projectorc projects get— Get projectorc projects update— Update projectorc projects restore— Restore an archived projectorc projects archive— Archive projectorc projects rollup get— Get Project progress rollup
orc projects list
List projects
Usage
orc projects list [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--workspace-id | string | No | Filter by workspace ID (for multi-workspace users). |
--include-archived | string | No | Include archived projects in the response.; enum: true|false |
--limit | number | No | Maximum number of items to return |
--cursor | string | No | Opaque 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 project list
Help
orc projects list --helporc projects create
Create project
Usage
orc projects create [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--idempotency-key | string | No | 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. |
--project-key | string | No | (required) URL-safe project identifier (must be unique within workspace). |
--name | string | No | (required) Display name. |
--description | string | No | Optional description. |
--workspace-id | string | No | Workspace to create the project in (defaults to current). |
--initiative-id | string | No | Optional parent Initiative ID in the same Workspace.; (use "null" or "reset" to clear) |
--milestone | string | No | Body field: milestone; (JSON object, e.g. '{"custom_id":"x"}') |
--display-order | number | No | Sort order in project lists. |
--color-token | string | No | Visual identity color token (Q2.CQ shared design tokens).; enum: default|gray|brown|orange|yellow|green|blue|purple|pink|red |
--identity-kind | string | No | Which kind of visual identity this project uses.; enum: color|initial|icon|emoji|image |
--icon-token | string | No | Icon token reference (when identity_kind=icon).; (use "null" or "reset" to clear); max 64 chars |
--emoji | string | No | Emoji glyph (when identity_kind=emoji).; (use "null" or "reset" to clear); max 32 chars |
--image-file-id | string | No | Reference to uploaded image file (when identity_kind=image).; (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 project create
Help
orc projects create --helporc projects get
Get project
Usage
orc projects get <key> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
key | Yes | Project key (URL-safe identifier). |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--workspace-id | string | No | Workspace context for the project key (required for organization-scoped credentials). |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc project get
Help
orc projects get --helporc projects update
Update project
Usage
orc projects update <key> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
key | Yes | Project key (URL-safe identifier). |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--workspace-id | string | No | Workspace context override (rare; defaults to current). |
--name | string | No | Project display name. |
--description | string | No | Project description. |
--display-order | number | No | Sort order in project lists. |
--visibility | string | No | workspace — visible to all workspace members. private — visible only to project members.; enum: workspace|private |
--color-token | string | No | Visual identity color token (Q2.CQ).; enum: default|gray|brown|orange|yellow|green|blue|purple|pink|red |
--identity-kind | string | No | Which kind of visual identity this project uses.; enum: color|initial|icon|emoji|image |
--icon-token | string | No | Body field: icon_token; (use "null" or "reset" to clear); max 64 chars |
--emoji | string | No | Body field: emoji; (use "null" or "reset" to clear); max 32 chars |
--image-file-id | string | No | Body field: image_file_id; (use "null" or "reset" to clear) |
--initiative-id | string | No | Optional parent Initiative ID in the same Workspace.; (use "null" or "reset" to clear) |
--milestone | string | No | Body field: milestone; (JSON object, e.g. '{"custom_id":"x"}') |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc project update
Help
orc projects update --helporc projects restore
Restore an archived project
Usage
orc projects restore <key> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
key | Yes | Project key (URL-safe identifier). |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--idempotency-key | string | No | 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. |
See global flags for output and request options. Use --help to check the flags supported by this command.
Help
orc projects restore --helporc projects archive
Archive project
Usage
orc projects archive <key> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
key | Yes | Project key (URL-safe identifier). |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--idempotency-key | string | No | 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. |
--workspace-id | string | No | Workspace containing the project to archive (required for organization-scoped credentials). |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc project archive
Help
orc projects archive --helporc projects rollup get
Get Project progress rollup
Usage
orc projects rollup get <id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Project ID or existing Project key. |
See global flags for output and request options. Use --help to check the flags supported by this command.
Help
orc projects rollup get --help