ops
💻 CTO.ai Ops - The CLI built for Teams 🚀

Usage
$ npm install -g @cto.ai/ops-rc
$ ops COMMAND
running command...
$ ops (-v|--version|version)
@cto.ai/ops-rc/1.5.17 darwin-x64 node-v11.14.0
$ ops --help [COMMAND]
USAGE
$ ops COMMAND
...
Commands
ops account:reset
Reset your password.
USAGE
$ ops account:reset
See code: src/commands/account/reset.ts
ops account:signin
Logs in to your account.
USAGE
$ ops account:signin
OPTIONS
-h, --help show CLI help
See code: src/commands/account/signin.ts
ops account:signout
Log out from your account.
USAGE
$ ops account:signout
OPTIONS
-h, --help show CLI help
See code: src/commands/account/signout.ts
ops account:signup
Creates an account to use with ops CLI.
USAGE
$ ops account:signup
OPTIONS
-h, --help show CLI help
See code: src/commands/account/signup.ts
ops account:support
Contact our support team with questions.
USAGE
$ ops account:support
OPTIONS
-h, --help show CLI help
See code: src/commands/account/support.ts
ops build [PATH]
Build your op for sharing.
USAGE
$ ops build [PATH]
ARGUMENTS
PATH Path to the op you want to build.
OPTIONS
-h, --help show CLI help
See code: src/commands/build.ts
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
See code: src/commands/cleanup.ts
ops help [COMMAND]
display help for ops
USAGE
$ ops help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
ops init
Easily create a new op.
USAGE
$ ops init
OPTIONS
-h, --help show CLI help
See code: src/commands/init.ts
ops list
Lists the ops you have in your team
USAGE
$ ops list
OPTIONS
-h, --help show CLI help
See code: src/commands/list.ts
ops publish PATH
Publish an op to a team.
USAGE
$ ops publish PATH
ARGUMENTS
PATH Path to the op you want to publish.
OPTIONS
-h, --help show CLI help
See code: src/commands/publish.ts
ops remove [OPNAME]
Remove an op from a team.
USAGE
$ ops remove [OPNAME]
ARGUMENTS
OPNAME A part of the name or description of the op or workflow you want to remove.
OPTIONS
-h, --help show CLI help
See code: src/commands/remove.ts
ops run [NAMEORPATH]
Run an op from the registry.
USAGE
$ ops run [NAMEORPATH]
ARGUMENTS
NAMEORPATH Name or path of the op or workflow you want to run.
OPTIONS
-b, --build Builds the op before running. Must provide a path to the op.
-h, --help show CLI help
See code: src/commands/run.ts
ops search [FILTER]
Search for ops in your workspaces.
USAGE
$ ops search [FILTER]
ARGUMENTS
FILTER Filters op results which include filter text in op name or description.
OPTIONS
-h, --help show CLI help
See code: src/commands/search.ts
ops team:create
Create your team.
USAGE
$ ops team:create
OPTIONS
-h, --help show CLI help
-n, --name=name
See code: src/commands/team/create.ts
ops team:invite
Invite your team members.
USAGE
$ ops team:invite
OPTIONS
-h, --help show CLI help
-i, --invitees=invitees A comma-separated string of usernames/emails we want to invite. E.g. ("user1,
user2@gmail.com, user3@something")
See code: src/commands/team/invite.ts
ops team:join
Accept an invite to join a team.
USAGE
$ ops team:join
See code: src/commands/team/join.ts
ops team:switch
Shows the list of your teams.
USAGE
$ ops team:switch
OPTIONS
-h, --help show CLI help
See code: src/commands/team/switch.ts
ops update
Update the ops CLI.
USAGE
$ ops update
OPTIONS
-h, --help show CLI help
See code: src/commands/update.ts
ops whoami
Display your user information
USAGE
$ ops whoami
OPTIONS
-h, --help show CLI help
See code: src/commands/whoami.ts
OClif Source Repo
Useful reference for writing tests:
Testing
Isolate tests (run only specific tests in that file):
test.only('it should run only tests suffixed with .only', async () => {
Unit Tests (test
directory)
How to run Unit Tests
npm test
or npm t
Tips
Run a single unit test, or filter them by filename:
npx jest --testPathPattern=keycloak
E2E Tests (test_e2e
directory)
These are known as "cli-acceptance-tests" in Concourse: https://concourse.stg-platform.hc.ai/teams/main/pipelines/ci/jobs/cli-acceptance/
How to run E2E tests locally
The default test server is staging, but you can override this by passing in your own OPS_REGISTRY_HOST
and OPS_API_HOST
values from your shell config.
Run tests against staging:
- Run
npm run configdev
to point the ops binary at the development Typescript app (instead of the production Javascript bundle) - Ensure you have a
.env.staging
file (you can generate one by running scripts/make-env.sh) - Set your
NODE_ENV
to 'staging': export NODE_ENV=staging
npm run test:e2e
Run tests against Minikube:
- Run
npm run configdev
to point the ops binary at the development Typescript app (instead of the production Javascript bundle) - Ensure you have a
.env.test
file (you can generate one by running scripts/make-env.sh) - Modify the vars in
.env.test
to match your minikube IP - Set your
NODE_ENV
to 'test': export NODE_ENV=test
npm run test:e2e
Tips
Run a single E2E test, or filter test files by filename:
npm run test:e2e -- --testPathPattern=signin