roc-ctl v0.1.0-alpha.1

roc-ctl

ROC Command Line Interface

• Usage
• Commands
• Usage
• Commands

Usage

$ npm install -g roc-ctl
$ roc COMMAND
running command...
$ roc (--version)
roc-ctl/0.1.0-alpha.0 win32-x64 node-v12.15.0
$ roc --help [COMMAND]
USAGE
  $ roc COMMAND
...

$ npm install -g oclif-hello-world
$ oex COMMAND
running command...
$ oex (--version)
oclif-hello-world/0.0.0 darwin-x64 node-v16.13.1
$ oex --help [COMMAND]
USAGE
  $ oex COMMAND
...

Commands

• roc agent create
• roc agent delete [ID]
• roc agent list
• roc command
• roc config get-project
• roc config get-url
• roc config set-credentials
• roc config set-project PROJECT
• roc config set-url URL
• roc environment create
• roc environment delete [ID]
• roc environment list
• roc environment variables ID
• roc help [COMMAND]
• roc project create
• roc project delete [ID]
• roc project list
• roc task-force create
• roc task-force delete [ID]
• roc task-force exec ID
• roc task-force list

roc agent create

Create new agent for specific project

USAGE
  $ roc agent create -n <value> [-p <value>] [-o <value>]

FLAGS
  -n, --name=<value>     (required) Name of the agent
  -o, --os=<value>       Name of the agent
  -p, --project=<value>  Project identifier

DESCRIPTION
  Create new agent for specific project

EXAMPLES
  $ roc agent create -n z3-subnet-1 -p default
  [OK] Agent z3-subnet-1 created

roc agent delete [ID]

Delete agent by its identifier

USAGE
  $ roc agent delete [ID]

DESCRIPTION
  Delete agent by its identifier

EXAMPLES
  $ roc agent delete agent-1
  [OK] agent-1 deleted

roc agent list

List agents by project

USAGE
  $ roc agent list [-p <value>]

FLAGS
  -p, --project=<value>  Project identifier

DESCRIPTION
  List agents by project

EXAMPLES
  $ roc agent list -p default

roc command

USAGE
  $ roc command

See code: dist/commands/command.ts

roc config get-project

Set configurations for ROC

USAGE
  $ roc config get-project

DESCRIPTION
  Set configurations for ROC

EXAMPLES
  $ roc config get-project
  [OK] default-project

roc config get-url

Set configurations for ROC

USAGE
  $ roc config get-url

DESCRIPTION
  Set configurations for ROC

EXAMPLES
  $ roc config get-url
  [OK] http://example.roc-service.local

roc config set-credentials

Set credentials of ROC

USAGE
  $ roc config set-credentials -k <value> -s <value>

FLAGS
  -k, --key=<value>     (required) API Key of ROC Platform
  -s, --secret=<value>  (required) API Secret of ROC Platform

DESCRIPTION
  Set credentials of ROC

EXAMPLES
  $ roc config set-credentials --key [YOUR_KEY] --secret [YOUR_SECRET]
  [OK] Platform credentials saved

roc config set-project PROJECT

Set default project for Robot Operation Center CLI

USAGE
  $ roc config set-project [PROJECT]

ARGUMENTS
  PROJECT  Identifier of project

DESCRIPTION
  Set default project for Robot Operation Center CLI

EXAMPLES
  $ roc config set-project default-project
  [OK] default project set

roc config set-url URL

Set configurations for ROC

USAGE
  $ roc config set-url [URL]

ARGUMENTS
  URL  URL of the ROC Platform

DESCRIPTION
  Set configurations for ROC

EXAMPLES
  $ roc config set-url https://roc.platform
  ROC platform set to https://roc.platform

roc environment create

Create new environment for specific project

USAGE
  $ roc environment create -n <value> -v <value> [-p <value>] [-d <value>]

FLAGS
  -d, --description=<value>  Description of the environment
  -n, --name=<value>         (required) Name of the environment
  -p, --project=<value>      Project identifier
  -v, --variables=<value>    (required) Variables file of the environment

DESCRIPTION
  Create new environment for specific project

EXAMPLES
  $ roc environment create -p default -n development -v variables.yaml
  [OK] Environment development created

roc environment delete [ID]

Delete environment by its identifier

USAGE
  $ roc environment delete [ID]

DESCRIPTION
  Delete environment by its identifier

EXAMPLES
  $ roc environment delete development
  [OK] Environment development deleted

roc environment list

List environments by project

USAGE
  $ roc environment list [-p <value>]

FLAGS
  -p, --project=<value>  Project identifier

DESCRIPTION
  List environments by project

EXAMPLES
  $ roc environment list -p default

roc environment variables ID

Print variables of the environment

USAGE
  $ roc environment variables [ID]

DESCRIPTION
  Print variables of the environment

EXAMPLES
  $ roc environment variables [env-id]

roc help [COMMAND]

Display help for roc.

USAGE
  $ roc help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for roc.

See code: @oclif/plugin-help

roc project create

Create new project

USAGE
  $ roc project create -n <value>

FLAGS
  -n, --name=<value>  (required) Name of project

DESCRIPTION
  Create new project

EXAMPLES
  $ roc project create -n New Project
  [OK] New Project created

roc project delete [ID]

Delete project by its identifier

USAGE
  $ roc project delete [ID]

DESCRIPTION
  Delete project by its identifier

EXAMPLES
  $ roc project delete demo-project
  [OK] Environment demo-project deleted

roc project list

List projects

USAGE
  $ roc project list

DESCRIPTION
  List projects

EXAMPLES
  $ roc project list

roc task-force create

Create new task force for specific project

USAGE
  $ roc task-force create -p <value> -n <value>

FLAGS
  -n, --name=<value>     (required) Name of the task force
  -p, --project=<value>  (required) Project identifier

DESCRIPTION
  Create new task force for specific project

EXAMPLES
  $ roc task-force create -n api-health-checker -p default
  [OK] Task Force api-health-checker created

roc task-force delete [ID]

Delete task force by its identifier

USAGE
  $ roc task-force delete [ID]

DESCRIPTION
  Delete task force by its identifier

EXAMPLES
  $ roc task-force delete form-processor
  [OK] Task force form-processor deleted

roc task-force exec ID

Execute task force

USAGE
  $ roc task-force exec [ID] -e <value> -a <value>

FLAGS
  -a, --agent=<value>  (required) Agent identifier
  -e, --env=<value>    (required) Environment identifier

DESCRIPTION
  Execute task force

EXAMPLES
  $ roc task-force exec [task-force-id] --agent agent-1 --env development
  [OK] Job queued with agent agent-1 and environment development

roc task-force list

List task forces by project

USAGE
  $ roc task-force list -p <value>

FLAGS
  -p, --project=<value>  (required) Project identifier

DESCRIPTION
  List task forces by project

EXAMPLES
  $ roc task-force list -p default

• oex hello PERSON
• oex hello world
• oex help [COMMAND]
• oex plugins
• oex plugins:inspect PLUGIN...
• oex plugins:install PLUGIN...
• oex plugins:link PLUGIN
• oex plugins:uninstall PLUGIN...
• oex plugins update

oex hello PERSON

Say hello

USAGE
  $ oex hello [PERSON] -f <value>

ARGUMENTS
  PERSON  Person to say hello to

FLAGS
  -f, --from=<value>  (required) Whom is saying hello

DESCRIPTION
  Say hello

EXAMPLES
  $ oex hello friend --from oclif
  hello friend from oclif! (./src/commands/hello/index.ts)

See code: dist/commands/hello/index.ts

oex hello world

Say hello world

USAGE
  $ oex hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ oex hello world
  hello world! (./src/commands/hello/world.ts)

oex help [COMMAND]

Display help for oex.

USAGE
  $ oex help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for oex.

See code: @oclif/plugin-help

oex plugins

List installed plugins.

USAGE
  $ oex plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ oex plugins

See code: @oclif/plugin-plugins

oex plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ oex plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ oex plugins:inspect myplugin

oex plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ oex plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ oex plugins add

EXAMPLES
  $ oex plugins:install myplugin 

  $ oex plugins:install https://github.com/someuser/someplugin

  $ oex plugins:install someuser/someplugin

oex plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ oex plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLES
  $ oex plugins:link myplugin

oex plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ oex plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ oex plugins unlink
  $ oex plugins remove

oex plugins update

Update installed plugins.

USAGE
  $ oex plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.