1.0.1-c • Published 1 year ago
pincanna-cli v1.0.1-c
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g pincanna-cli
$ pincanna COMMAND
running command...
$ pincanna (--version)
pincanna-cli/1.0.1-c darwin-arm64 node-v16.17.0
$ pincanna --help [COMMAND]
USAGE
$ pincanna COMMAND
...
Commands
pincanna aws list-regions
pincanna ec2 list-instances
pincanna help [COMMANDS]
pincanna plugins
pincanna plugins:install PLUGIN...
pincanna plugins:inspect PLUGIN...
pincanna plugins:install PLUGIN...
pincanna plugins:link PLUGIN
pincanna plugins:uninstall PLUGIN...
pincanna plugins:uninstall PLUGIN...
pincanna plugins:uninstall PLUGIN...
pincanna plugins update
pincanna aws list-regions
List all AWS Regions enabled for our account.
USAGE
$ pincanna aws list-regions
DESCRIPTION
List all AWS Regions enabled for our account.
EXAMPLES
$ pincanna aws list-regions
pincanna ec2 list-instances
List all EC2 instances in our account.
USAGE
$ pincanna ec2 list-instances
DESCRIPTION
List all EC2 instances in our account.
EXAMPLES
$ pincanna ec2 list-instances
pincanna help [COMMANDS]
Display help for pincanna.
USAGE
$ pincanna 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 pincanna.
See code: @oclif/plugin-help
pincanna plugins
List installed plugins.
USAGE
$ pincanna plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ pincanna plugins
See code: @oclif/plugin-plugins
pincanna plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ pincanna 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
$ pincanna plugins add
EXAMPLES
$ pincanna plugins:install myplugin
$ pincanna plugins:install https://github.com/someuser/someplugin
$ pincanna plugins:install someuser/someplugin
pincanna plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ pincanna 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
$ pincanna plugins:inspect myplugin
pincanna plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ pincanna 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
$ pincanna plugins add
EXAMPLES
$ pincanna plugins:install myplugin
$ pincanna plugins:install https://github.com/someuser/someplugin
$ pincanna plugins:install someuser/someplugin
pincanna plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ pincanna 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
$ pincanna plugins:link myplugin
pincanna plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ pincanna plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ pincanna plugins unlink
$ pincanna plugins remove
pincanna plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ pincanna plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ pincanna plugins unlink
$ pincanna plugins remove
pincanna plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ pincanna plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ pincanna plugins unlink
$ pincanna plugins remove
pincanna plugins update
Update installed plugins.
USAGE
$ pincanna plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.