Skip to content
Operately Logo Operately Logo Operately Help Center

Use the Operately CLI

Most Operately CLI commands follow this shape:

Terminal window
operately <namespace> <command> [flags]

Examples:

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

Authentication commands are separate utility commands:

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

Use help to discover commands#

Section titled “Use help to discover commands#”

Start with general help:

Terminal window
operately help

List commands in a namespace:

Terminal window
operately help projects

Show command-specific help:

Terminal window
operately help projects list

You can also request help inline:

Terminal window
operately projects list --help

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

Common examples#

Section titled “Common examples#”

Get information about the authenticated user:

Terminal window
operately people get_me

List spaces:

Terminal window
operately spaces list

List projects and include space details:

Terminal window
operately projects list --include-space

Write command output to a file:

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

Print compact JSON:

Terminal window
operately spaces list --compact

Keep the reference in the API docs#

Section titled “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.