Use the CLI

Most Operately CLI commands follow this shape:

operately <namespace> <command> [flags]

Examples:

operately people get_me
operately spaces list
operately projects list --include-space

Authentication commands are separate utility commands:

operately auth login --token <token>
operately auth whoami

Use help to discover commands#

Start with general help:

operately help

List commands in a namespace:

operately help projects

Show command-specific help:

operately help projects list

You can also request help inline:

operately projects list --help

Use command-specific help whenever you need to see the available flags for a specific endpoint.

Common examples#

Get information about the authenticated user:

operately people get_me

List spaces:

operately spaces list

List projects and include space details:

operately projects list --include-space

Write command output to a file:

operately projects list --include-space --output ./projects.json

Print compact JSON:

operately spaces list --compact

Keep the reference in the API docs#

The CLI is a thin interface over the Operately external API. Use these docs for onboarding and discovery, then use the API docs when you need the full endpoint reference.