CLI Commands

The Ops Platform includes a command-line interface (called "the CLI") that allows terminal users to perform a wide variety of tasks. The CLI
is currently supported on MacOS and Linux (Windows is not yet
supported).

For example, using the CLI, you can initialize a new Op, manage your
teams, or publish Ops to the CTO.ai registry. Here is a list of commands that the CLI currently supports.

General Commands

ops help

The help command shows information about the versions of the CLI and dependencies that are installed.

USAGE
$ ops help

ops update

Update the Ops CLI.

USAGE
$ ops update

OPTIONS
-h, --help show CLI help

ops whoami

Display your user information

USAGE
$ ops whoami

OPTIONS
-h, --help show CLI help

Account Commands

ops account:reset

Resets your password.

USAGE
$ ops account:reset

ops account:signin

Log in to your account. This triggers a browser based signin/signup
form that allows you to continue with OAuth providers or a username
password set on signup.

USAGE
$ ops account:signin

OPTIONS
-h, --help show CLI help

ops account:signout

Log out from your account.

USAGE
$ ops account:signout

OPTIONS
-h, --help show CLI help

ops account:signup

Creates an account to use with The Ops Platform.

USAGE
$ ops account:signup

OPTIONS
-h, --help show CLI help

ops account:support

Contact our support team with questions.

USAGE
$ ops account:support

OPTIONS
-h, --help show CLI help

Op Commands

ops build [PATH]

Build your Op for sharing or testing.

USAGE
$ ops build [PATH]

ARGUMENTS
PATH Path to the Op you want to build.

OPTIONS
-h, --help show CLI help

ops cleanup [OPNAME]

Clean up locally cached docker images.

USAGE
$ ops cleanup [OPNAME]

ARGUMENTS
OPNAME Name of the Op to be cleaned up

OPTIONS
-h, --help show CLI help

ops help [COMMAND]

Display help for The Ops CLI.

USAGE
$ ops help [COMMAND]

ARGUMENTS
COMMAND command to show help for

OPTIONS
--all see all commands in CLI

ops init

Easily create a new Op. When you run this command, a series of
interactive configuration options will be presented. Scaffold code will
then be generated according to the selected options.

USAGE
$ ops init

OPTIONS
-h, --help show CLI help

ops publish [PATH]

Publish an Op to the team you are currently on.

USAGE
$ ops publish [PATH]

ARGUMENTS
PATH Path to the Op you want to publish.

OPTIONS
-h, --help show CLI help

ops remove [OPNAME]

Remove an Op from your team.

USAGE
$ ops remove [OPNAME]

ARGUMENTS
OPNAME Name of the Op you want to remove.

OPTIONS
-h, --help show CLI help

ops run [NAMEORPATH]

Run an Op from your team or the registry.

USAGE
$ ops run [NAMEORPATH]

ARGUMENTS
NAMEORPATH Name or path of the Op you want to run.

OPTIONS
-b, --build Builds the Op before running. Must provide a path to the Op.
-h, --help show CLI help

ops search [FILTER]

Search for Ops in your workspaces and publically shared Ops.

USAGE
$ ops search [FILTER]

ARGUMENTS
FILTER Filters Op results which include filter text in Op name or description.

OPTIONS
-h, --help show CLI help

ops list

Lists the Ops you have in your team.

USAGE
$ ops list

OPTIONS
-h, --help  show CLI help

ops add

Add an op to your team. ops add is favoriting an op from another team. When you ops add a public op, you will see it in the list of your team's ops.

USAGE
$ ops add [OPNAME]

ARGUMENTS
OPNAME  Name of the public op to be added to your team. It should be in the format - @teamname/opName:versionName

OPTIONS
-h, --help  show CLI help

Secrets Commands

ops secrets:delete

Delete a secret stored for the active team.

USAGE
$ ops secrets:delete

ops secrets:list

Lists secret stored for the active team.

USAGE
$ ops secrets:list

ops secrets:register

Register a secrets provider for a team.

USAGE
$ ops secrets:list

ops secrets:set

Add a key & value.

USAGE
$ ops secrets:set

ops secrets:unregister

Unregister a secrets provider for a team.

USAGE
$ ops secrets:list

Team Commands

ops team:create

Create your team.

USAGE
$ ops team:create

OPTIONS
-h, --help show CLI help
-n, --name=name

ops team:info

Displays details about your team and its members.

USAGE
$ ops team:invite

ops team:invite

Invite other Ops Platform users to join your team workspace.

USAGE
$ ops team:invite

OPTIONS
-h, --help show CLI help

-i, --inviteesInput=inviteesInput A comma-separated string of usernames/emails we want to invite. E.g. ("user1,
[email protected], [email protected]")

ops team:join

Accept an invite to join a team workspace.

USAGE
$ ops team:join

ops team:switch

Shows the list of your teams.

USAGE
$ ops team:switch

OPTIONS
-h, --help show CLI help

🚀 What's next?

• Start Building Ops in the CLI to run from Slack or check out our Build an Ops Tutorial for a step by step guide
• If your looking to customize the build of your Ops check out our Configuring Ops page
• You'll need to ensure you Publish your Ops to be able to run from Slack, where you can also share them with your team to run.