Skip to content

Latest commit

 

History

History
532 lines (370 loc) · 10.3 KB

README.md

File metadata and controls

532 lines (370 loc) · 10.3 KB

Sentinel CLI

Usage

$ npm install -g @sentinel-paas/sentinel-cli
$ sentinel COMMAND
running command...
$ sentinel (--version)
@sentinel-paas/sentinel-cli/0.0.10 linux-x64 node-v16.14.2
$ sentinel --help [COMMAND]
USAGE
  $ sentinel COMMAND
...

Commands

sentinel canary deploy

Initiates a canary deployment

USAGE
  $ sentinel canary deploy

DESCRIPTION
  Initiates a canary deployment

EXAMPLES
  $ sentinel canary deploy

sentinel canary promote

Promotes the canary version of the application to full production and removes the previous production application

USAGE
  $ sentinel canary promote

DESCRIPTION
  Promotes the canary version of the application to full production and removes the previous production application

EXAMPLES
  $ sentinel canary promote

sentinel canary rollback

Removes the canary version of the application and directs all user traffic back to the original production version.

USAGE
  $ sentinel canary rollback

DESCRIPTION
  Removes the canary version of the application and directs all user traffic back to the original production version.

EXAMPLES
  $ sentinel canary rollback

sentinel canary traffic

Changes the amount of traffic going to the canary

USAGE
  $ sentinel canary traffic

DESCRIPTION
  Changes the amount of traffic going to the canary

EXAMPLES
  $ sentinel canary traffic

sentinel cluster inspect

This command allows you to obtain information about the cluster.

USAGE
  $ sentinel cluster inspect

DESCRIPTION
  This command allows you to obtain information about the cluster.

EXAMPLES
  $ sentinel cluster inspect

sentinel cluster scale

This command scales your cluster up or down.

USAGE
  $ sentinel cluster scale

DESCRIPTION
  This command scales your cluster up or down.

EXAMPLES
  $ sentinel cluster scale

sentinel deploy

Deploy your application

USAGE
  $ sentinel deploy

DESCRIPTION
  Deploy your application

EXAMPLES
  $ sentinel deploy

See code: dist/commands/deploy.ts

sentinel destroy

Destroy the entire Sentinel infrastructure and all of your applications.

USAGE
  $ sentinel destroy

DESCRIPTION
  Destroy the entire Sentinel infrastructure and all of your applications.

EXAMPLES
  $ sentinel destroy

See code: dist/commands/destroy.ts

sentinel help [COMMAND]

Display help for sentinel.

USAGE
  $ sentinel 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 sentinel.

See code: @oclif/plugin-help

sentinel init

Initialize Sentinel infrastructure

USAGE
  $ sentinel init

DESCRIPTION
  Initialize Sentinel infrastructure

EXAMPLES
  $ sentinel init

See code: dist/commands/init.ts

sentinel inspect app

Provides deployment information on a specific application

USAGE
  $ sentinel inspect app

DESCRIPTION
  Provides deployment information on a specific application

EXAMPLES
  $ sentinel inspect app

sentinel inspect inventory

List all deployed applications

USAGE
  $ sentinel inspect inventory

DESCRIPTION
  List all deployed applications

EXAMPLES
  $ sentinel inspect inventory

sentinel inspect logs

Provides application logs

USAGE
  $ sentinel inspect logs

DESCRIPTION
  Provides application logs

EXAMPLES
  $ sentinel inspect logs

sentinel metrics

Initialize domains for application metrics.

USAGE
  $ sentinel metrics

DESCRIPTION
  Initialize domains for application metrics.

EXAMPLES
  $ sentinel metrics

See code: dist/commands/metrics.ts

sentinel plugins

List installed plugins.

USAGE
  $ sentinel plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ sentinel plugins

See code: @oclif/plugin-plugins

sentinel plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ sentinel 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
  $ sentinel plugins add

EXAMPLES
  $ sentinel plugins:install myplugin 

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

  $ sentinel plugins:install someuser/someplugin

sentinel plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ sentinel 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
  $ sentinel plugins:inspect myplugin

sentinel plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ sentinel 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
  $ sentinel plugins add

EXAMPLES
  $ sentinel plugins:install myplugin 

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

  $ sentinel plugins:install someuser/someplugin

sentinel plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ sentinel 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
  $ sentinel plugins:link myplugin

sentinel plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ sentinel plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ sentinel plugins unlink
  $ sentinel plugins remove

sentinel plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ sentinel plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ sentinel plugins unlink
  $ sentinel plugins remove

sentinel plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ sentinel plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ sentinel plugins unlink
  $ sentinel plugins remove

sentinel plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

sentinel remove app

Removes an application from production.

USAGE
  $ sentinel remove app

DESCRIPTION
  Removes an application from production.

EXAMPLES
  $ sentinel remove app

sentinel scale app

Scale an application up or down

USAGE
  $ sentinel scale app

DESCRIPTION
  Scale an application up or down

EXAMPLES
  $ sentinel scale app