constable-cli v0.1.0

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g constable
$ constable COMMAND
running command...
$ constable (--version)
constable/0.1.0 darwin-arm64 node-v16.3.0
$ constable --help [COMMAND]
USAGE
  $ constable COMMAND
...

Commands

• constable analyze [PATH]
• constable configure [FILE]
• constable foobar [FILE]
• constable help [COMMAND]
• constable plugins
• constable plugins:install PLUGIN...
• constable plugins:inspect PLUGIN...
• constable plugins:install PLUGIN...
• constable plugins:link PLUGIN
• constable plugins:uninstall PLUGIN...
• constable plugins:uninstall PLUGIN...
• constable plugins:uninstall PLUGIN...
• constable plugins update
• constable resources
• constable rule add RULE_FNAME
• constable rule delete RULE_ID
• constable rule get RULE_ID
• constable rule list
• constable rule update RULE_FNAME RULE_ID
• constable update [CHANNEL]
• constable whoami

constable analyze [PATH]

Run terraform to constable

USAGE
  $ constable analyze [PATH] [-h] [-f] [--api_key <value>] [--github_ref <value>] [--github_repository
    <value>]

ARGUMENTS
  PATH  A path to terraform root module. Uses $CWD if not specified

FLAGS
  -f, --force                  Proceed without any confirmations
  -h, --help                   Show CLI help.
  --api_key=<value>            A constable api key
  --github_ref=<value>         If running from github actions, you must pass the value in $GITHUB_REF
  --github_repository=<value>  If running from github actions, you must pass the value in $GITHUB_REPOSITORY

DESCRIPTION
  Run terraform to constable

EXAMPLES
  $ constable analyze [path_to_terraform_root]

See code: dist/commands/analyze.ts

constable configure [FILE]

configure the cli

USAGE
  $ constable configure [FILE] [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  configure the cli

EXAMPLES
  $ constable configure

See code: dist/commands/configure.ts

constable foobar [FILE]

describe the command here

USAGE
  $ constable foobar [FILE] [-n <value>] [-f]

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  describe the command here

EXAMPLES
  $ constable foobar

See code: dist/commands/foobar.ts

constable help [COMMAND]

Display help for constable.

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

See code: @oclif/plugin-help

constable plugins

List installed plugins.

USAGE
  $ constable plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ constable plugins

See code: @oclif/plugin-plugins

constable plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ constable plugins:install myplugin 

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

  $ constable plugins:install someuser/someplugin

constable plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

constable plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ constable plugins:install myplugin 

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

  $ constable plugins:install someuser/someplugin

constable plugins:link PLUGIN

Links a plugin into the CLI for development.

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

constable plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ constable plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ constable plugins unlink
  $ constable plugins remove

constable plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ constable plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ constable plugins unlink
  $ constable plugins remove

constable plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ constable plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ constable plugins unlink
  $ constable plugins remove

constable plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

constable resources

Get Resources

USAGE
  $ constable resources [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Get Resources

EXAMPLES
  $ constable resources
    {...resources...}

See code: dist/commands/resources.ts

constable rule add RULE_FNAME

Add a constable rule

USAGE
  $ constable rule add [RULE_FNAME] [-h]

ARGUMENTS
  RULE_FNAME  Name of the file with the rule to add

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Add a constable rule

EXAMPLES
  $ constable rule add fname

constable rule delete RULE_ID

Delete a constable rule

USAGE
  $ constable rule delete [RULE_ID] [-h]

ARGUMENTS
  RULE_ID  Id of the rule to delete

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Delete a constable rule

EXAMPLES
  $ constable rule delete id

constable rule get RULE_ID

Get constable rules

USAGE
  $ constable rule get [RULE_ID] [-h]

ARGUMENTS
  RULE_ID  Id of the rule to get

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Get constable rules

EXAMPLES
  $ constable rule list

constable rule list

List constable rules

USAGE
  $ constable rule list [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  List constable rules

EXAMPLES
  $ constable rule list

constable rule update RULE_FNAME RULE_ID

Update a constable rule

USAGE
  $ constable rule update [RULE_FNAME] [RULE_ID] [-h]

ARGUMENTS
  RULE_FNAME  Name of the file with the rule to update
  RULE_ID     Id of the rule to update

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Update a constable rule

EXAMPLES
  $ constable rule update fname id

constable update [CHANNEL]

update the constable CLI

USAGE
  $ constable update [CHANNEL] [-a] [-v <value> | -i] [--force]

FLAGS
  -a, --available        Install a specific version.
  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
  -v, --version=<value>  Install a specific version.
  --force                Force a re-download of the requested version.

DESCRIPTION
  update the constable CLI

EXAMPLES
  Update to the stable channel:

    $ constable update stable

  Update to a specific version:

    $ constable update --version 1.0.0

  Interactively select version:

    $ constable update --interactive

  See available versions:

    $ constable update --available

See code: @oclif/plugin-update

constable whoami

Check that your API Key is working

USAGE
  $ constable whoami [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Check that your API Key is working

EXAMPLES
  $ constable whoami
    hello jeff@amazon.com!

See code: dist/commands/whoami.ts