CLI Commands

Here are the following commands that the op currently supports

Account-related commands:

  • ops account:reset
  • ops account:signin
  • ops account:signout
  • ops account:signup
  • ops account:support
  • ops update
  • ops whoami

Op-related commands:

  • ops build [PATH]
  • ops cleanup [OPNAME]
  • ops help [COMMAND]
  • ops init
  • ops publish [PATH]
  • ops remove [OPNAME]
  • ops run [NAMEORPATH]
  • ops search [FILTER]

Team-related commands:

  • ops team:create
  • ops team:invite
  • ops team:join
  • ops team:switch

ops account:reset

Resets your password.

USAGE
$ ops account:reset

ops account:signin

Logs 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

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. After running this command, you will be prompted to select a template to use for the type of Op that you would like to create (i.e. Command, or Workflow, etc).

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 a 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 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 team:create

Create your team.

USAGE
$ ops team:create

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

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

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