poc-cli-1
v1.0.8
Published
A new CLI generated with oclif
Readme
custom-cli
A new CLI generated with oclif
Usage
$ npm install -g poc-cli-1
$ custom-cli COMMAND
running command...
$ custom-cli (--version)
poc-cli-1/1.0.8 win32-x64 node-v22.18.0
$ custom-cli --help [COMMAND]
USAGE
$ custom-cli COMMAND
...$ npm install -g poc-cli-1
$ custom-cliff COMMAND
running command...
$ custom-cliff (--version)
poc-cli-1/1.0.2 win32-x64 node-v22.18.0
$ custom-cliff --help [COMMAND]
USAGE
$ custom-cliff COMMAND
...Commands
custom-cli byecustom-cli goodbye PERSONcustom-cli hello PERSONcustom-cli hello world [NAME]custom-cli help [COMMAND]custom-cli pluginscustom-cli plugins add PLUGINcustom-cli plugins:inspect PLUGIN...custom-cli plugins install PLUGINcustom-cli plugins link PATHcustom-cli plugins remove [PLUGIN]custom-cli plugins resetcustom-cli plugins uninstall [PLUGIN]custom-cli plugins unlink [PLUGIN]custom-cli plugins update
custom-cli bye
Says goodbye after asking a series of questions
USAGE
$ custom-cli bye
DESCRIPTION
Says goodbye after asking a series of questionsSee code: src/commands/bye/index.ts
custom-cli goodbye PERSON
Says goodbye to someone
USAGE
$ custom-cli goodbye PERSON
ARGUMENTS
PERSON Person to say goodbye to
DESCRIPTION
Says goodbye to someoneSee code: src/commands/goodbye/index.ts
custom-cli hello PERSON
Say hello
USAGE
$ custom-cli hello PERSON -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Who is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ custom-cli hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)See code: src/commands/hello/index.ts
custom-cli hello world [NAME]
Say hello world
USAGE
$ custom-cli hello world [NAME]
ARGUMENTS
NAME Name to say hello to
DESCRIPTION
Say hello world
EXAMPLES
$ custom-cli hello world
hello world! (./src/commands/hello/world.ts)See code: src/commands/hello/world.ts
custom-cli help [COMMAND]
Display help for custom-cli.
USAGE
$ custom-cli 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 custom-cli.See code: @oclif/plugin-help
custom-cli plugins
List installed plugins.
USAGE
$ custom-cli plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ custom-cli pluginsSee code: @oclif/plugin-plugins
custom-cli plugins add PLUGIN
Installs a plugin into custom-cli.
USAGE
$ custom-cli plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into custom-cli.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the CUSTOM_CLI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the CUSTOM_CLI_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ custom-cli plugins add
EXAMPLES
Install a plugin from npm registry.
$ custom-cli plugins add myplugin
Install a plugin from a github url.
$ custom-cli plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ custom-cli plugins add someuser/someplugincustom-cli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ custom-cli 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
$ custom-cli plugins inspect mypluginSee code: @oclif/plugin-plugins
custom-cli plugins install PLUGIN
Installs a plugin into custom-cli.
USAGE
$ custom-cli plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into custom-cli.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the CUSTOM_CLI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the CUSTOM_CLI_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ custom-cli plugins add
EXAMPLES
Install a plugin from npm registry.
$ custom-cli plugins install myplugin
Install a plugin from a github url.
$ custom-cli plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ custom-cli plugins install someuser/somepluginSee code: @oclif/plugin-plugins
custom-cli plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ custom-cli plugins link PATH [-h] [--install] [-v]
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
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
$ custom-cli plugins link mypluginSee code: @oclif/plugin-plugins
custom-cli plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ custom-cli plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ custom-cli plugins unlink
$ custom-cli plugins remove
EXAMPLES
$ custom-cli plugins remove myplugincustom-cli plugins reset
Remove all user-installed and linked plugins.
USAGE
$ custom-cli plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.See code: @oclif/plugin-plugins
custom-cli plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ custom-cli plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ custom-cli plugins unlink
$ custom-cli plugins remove
EXAMPLES
$ custom-cli plugins uninstall mypluginSee code: @oclif/plugin-plugins
custom-cli plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ custom-cli plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ custom-cli plugins unlink
$ custom-cli plugins remove
EXAMPLES
$ custom-cli plugins unlink myplugincustom-cli plugins update
Update installed plugins.
USAGE
$ custom-cli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
custom-cliff goodbye PERSONcustom-cliff hello PERSONcustom-cliff hello worldcustom-cliff help [COMMAND]custom-cliff pluginscustom-cliff plugins add PLUGINcustom-cliff plugins:inspect PLUGIN...custom-cliff plugins install PLUGINcustom-cliff plugins link PATHcustom-cliff plugins remove [PLUGIN]custom-cliff plugins resetcustom-cliff plugins uninstall [PLUGIN]custom-cliff plugins unlink [PLUGIN]custom-cliff plugins update
custom-cliff goodbye PERSON
Says goodbye to someone
USAGE
$ custom-cliff goodbye PERSON
ARGUMENTS
PERSON Person to say goodbye to
DESCRIPTION
Says goodbye to someoneSee code: src/commands/goodbye/index.ts
custom-cliff hello PERSON
Say hello
USAGE
$ custom-cliff hello PERSON -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Who is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ custom-cliff hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)See code: src/commands/hello/index.ts
custom-cliff hello world
Say hello world
USAGE
$ custom-cliff hello world
DESCRIPTION
Say hello world
EXAMPLES
$ custom-cliff hello world
hello world! (./src/commands/hello/world.ts)See code: src/commands/hello/world.ts
custom-cliff help [COMMAND]
Display help for custom-cliff.
USAGE
$ custom-cliff 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 custom-cliff.See code: @oclif/plugin-help
custom-cliff plugins
List installed plugins.
USAGE
$ custom-cliff plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ custom-cliff pluginsSee code: @oclif/plugin-plugins
custom-cliff plugins add PLUGIN
Installs a plugin into custom-cliff.
USAGE
$ custom-cliff plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into custom-cliff.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the CUSTOM_CLIFF_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the CUSTOM_CLIFF_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ custom-cliff plugins add
EXAMPLES
Install a plugin from npm registry.
$ custom-cliff plugins add myplugin
Install a plugin from a github url.
$ custom-cliff plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ custom-cliff plugins add someuser/someplugincustom-cliff plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ custom-cliff 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
$ custom-cliff plugins inspect mypluginSee code: @oclif/plugin-plugins
custom-cliff plugins install PLUGIN
Installs a plugin into custom-cliff.
USAGE
$ custom-cliff plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into custom-cliff.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the CUSTOM_CLIFF_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the CUSTOM_CLIFF_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ custom-cliff plugins add
EXAMPLES
Install a plugin from npm registry.
$ custom-cliff plugins install myplugin
Install a plugin from a github url.
$ custom-cliff plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ custom-cliff plugins install someuser/somepluginSee code: @oclif/plugin-plugins
custom-cliff plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ custom-cliff plugins link PATH [-h] [--install] [-v]
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
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
$ custom-cliff plugins link mypluginSee code: @oclif/plugin-plugins
custom-cliff plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ custom-cliff plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ custom-cliff plugins unlink
$ custom-cliff plugins remove
EXAMPLES
$ custom-cliff plugins remove myplugincustom-cliff plugins reset
Remove all user-installed and linked plugins.
USAGE
$ custom-cliff plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.See code: @oclif/plugin-plugins
custom-cliff plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ custom-cliff plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ custom-cliff plugins unlink
$ custom-cliff plugins remove
EXAMPLES
$ custom-cliff plugins uninstall mypluginSee code: @oclif/plugin-plugins
custom-cliff plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ custom-cliff plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ custom-cliff plugins unlink
$ custom-cliff plugins remove
EXAMPLES
$ custom-cliff plugins unlink myplugincustom-cliff plugins update
Update installed plugins.
USAGE
$ custom-cliff plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
