sentinel-paas v0.0.1

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g sentinel-paas
$ sentinel COMMAND
running command...
$ sentinel (--version)
sentinel-paas/0.0.1 linux-x64 node-v14.18.0
$ sentinel --help [COMMAND]
USAGE
  $ sentinel COMMAND
...

Commands

• sentinel canary
• sentinel deploy
• sentinel destroy
• sentinel health
• sentinel help [COMMAND]
• sentinel init
• sentinel inventory
• sentinel plugins
• sentinel plugins:install PLUGIN...
• sentinel plugins:inspect PLUGIN...
• sentinel plugins:install PLUGIN...
• sentinel plugins:link PLUGIN
• sentinel plugins:uninstall PLUGIN...
• sentinel plugins:uninstall PLUGIN...
• sentinel plugins:uninstall PLUGIN...
• sentinel plugins update
• sentinel remove
• sentinel test

sentinel canary

These commands are used to manage canary deployments for your application

USAGE
  $ sentinel canary [-d] [-t] [-p] [-r]

FLAGS
  -d, --deploy    Make a canary deployment
  -p, --promote   Promote the canary deployment to production
  -r, --rollback  Rollback the canary deployment
  -t, --traffic   Increase traffic to the canary deployment

DESCRIPTION
  These commands are used to manage canary deployments for your application

EXAMPLES
  $ sentinel canary

See code: dist/commands/canary.ts

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 health

Specify the name of an application and check its health status.

USAGE
  $ sentinel health

DESCRIPTION
  Specify the name of an application and check its health status.

EXAMPLES
  $ sentinel health

See code: dist/commands/health.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

USAGE
  $ sentinel init

DESCRIPTION
  Initialize Sentinel

EXAMPLES
  $ sentinel init

See code: dist/commands/init.ts

sentinel inventory

List all deployed applications

USAGE
  $ sentinel inventory

DESCRIPTION
  List all deployed applications

EXAMPLES
  $ sentinel inventory

See code: dist/commands/inventory.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

Remove an application from production. This is not meant for canary deployments

USAGE
  $ sentinel remove -a <value>

FLAGS
  -a, --app=<value>  (required) application name

DESCRIPTION
  Remove an application from production. This is not meant for canary deployments

EXAMPLES
  $ sentinel remove -a <myapp>

See code: dist/commands/remove.ts

sentinel test

describe the command here

USAGE
  $ sentinel test

DESCRIPTION
  describe the command here

EXAMPLES
  $ sentinel test

See code: dist/commands/test.ts