Operately CLI

The Operately CLI is a terminal interface for the Operately external API.

It installs two equivalent binaries:

• operately
• op

Use the CLI when you want to query or update Operately from scripts, local automation, or an interactive shell. For complete endpoint-by-endpoint reference, use the API docs.

Quick start#

Install the CLI#

npm install -g @operately/operately-cli

New user? Sign up and create a company interactively#

operately auth signup

Existing user? Log in (token, password, email code, or Google)#

operately auth login

Verify authentication#

operately auth whoami

Discover commands#

operately help
operately help projects

Run an API command#

operately people get_me

What to read next#

• Install and update the CLI
• Sign up and create a company
• Authenticate the CLI
• Install Operately skills
• Learn the command shape and help system
• Browse the API docs