cld-cli

cld CLI - managing cloud resources from the command-line

• cld-cli
• Usage
• Commands

Usage

$ npm install -g cld-cli
$ cld COMMAND
running command...
$ cld (--version)
cld-cli/0.3.15 linux-x64 node-v18.14.0
$ cld --help [COMMAND]
USAGE
  $ cld COMMAND
...

Commands

• cld aws
• cld aws whoami
• cld help [COMMANDS]
• cld plugins
• cld plugins:install PLUGIN...
• cld plugins:inspect PLUGIN...
• cld plugins:install PLUGIN...
• cld plugins:link PLUGIN
• cld plugins:uninstall PLUGIN...
• cld plugins:uninstall PLUGIN...
• cld plugins:uninstall PLUGIN...
• cld plugins update

cld aws

AWS quick utilities

USAGE
  $ cld aws

DESCRIPTION
  AWS quick utilities

EXAMPLES
  $ cld aws
  AWS_ACCESS_KEY_ID=A***************1111
  AWS_SECRET_ACCESS_KEY=Z***********************************zzzz
  or
  AWS_PROFILE=work

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

cld aws whoami

USAGE
  $ cld aws whoami

EXAMPLES
  $ cld aws whoami
  UserId: Axxxxxxxxxxxxxxxxxxxx
  Account: 111111111111
  Arn: arn:aws:iam::111111111111:user/cld-cli

cld help [COMMANDS]

Display help for cld.

USAGE
  $ cld help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

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

DESCRIPTION
  Display help for cld.

See code: @oclif/plugin-help

cld plugins

List installed plugins.

USAGE
  $ cld plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ cld plugins

See code: @oclif/plugin-plugins

cld plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ cld plugins:install myplugin 

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

  $ cld plugins:install someuser/someplugin

cld plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ cld plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

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

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ cld plugins:inspect myplugin

cld plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ cld plugins:install myplugin 

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

  $ cld plugins:install someuser/someplugin

cld plugins:link PLUGIN

Links a plugin into the CLI for development.

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

cld plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ cld plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ cld plugins unlink
  $ cld plugins remove

cld plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ cld plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ cld plugins unlink
  $ cld plugins remove

cld plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ cld plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ cld plugins unlink
  $ cld plugins remove

cld plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

Releases and Publishing to npmjs

Using release-it for releases.

To do a release run the Github Release workflow on main. Use this action: https://github.com/markcallen/cld-cli/actions/workflows/release.yml and run against the main branch.

To to a minor (or major) vesion change run

npm run release -- minor --ci

Development

Setup

Install node

nvm use

Running

Use bin/dev instead of cld directory

bin/dev aws --help

Testing

Tests are written using mocha

yarn test

License

Distributed under the Apache-2.0 License. See LICENSE for more information.

Contact

Your Name - @markcallen

Project Link: https://github.com/markcallen/cld-cli