Getting started

personas

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

Commands

  • orc personas list — List personas
  • orc personas create — Create a persona
  • orc personas get — Get a persona
  • orc personas update — Update a persona
  • orc personas delete — Soft-delete a persona

orc personas list

List personas

Usage

orc personas list [flags]

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.

Compatibility aliases

  • orc persona list

Help

orc personas list --help

orc personas create

Create a persona

Usage

orc personas 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.
--namestringNo(required) Body field: name
--descriptionstringNoBody field: description; (use "null" or "reset" to clear)
--personastringNo3-axis structure: behavior + demographics + employment. All fields nullable to minimize initial input friction. Field names use camelCase.; (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 persona create

Help

orc personas create --help

orc personas get

Get a persona

Usage

orc personas 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 persona get

Help

orc personas get --help

orc personas update

Update a persona

Usage

orc personas update <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

Flags

FlagTypeRequiredDescription
--namestringNoBody field: name
--descriptionstringNoBody field: description; (use "null" or "reset" to clear)
--personastringNo3-axis structure: behavior + demographics + employment. All fields nullable to minimize initial input friction. Field names use camelCase.; (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 persona update

Help

orc personas update --help

orc personas delete

Soft-delete a persona

Usage

orc personas 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 persona delete

Help

orc personas delete --help