oclif-tester
v0.3.0
Published
A new CLI generated with oclif
Downloads
6
Readme
oclif-tester
A new CLI generated with oclif
Usage
$ npm install -g oclif-tester
$ oclif-tester COMMAND
running command...
$ oclif-tester (--version)
oclif-tester/0.3.0 linux-x64 node-v20.13.1
$ oclif-tester --help [COMMAND]
USAGE
$ oclif-tester COMMAND
...
Commands
oclif-tester hello PERSON
oclif-tester hello world
oclif-tester help [COMMAND]
oclif-tester plugins
oclif-tester plugins add PLUGIN
oclif-tester plugins:inspect PLUGIN...
oclif-tester plugins install PLUGIN
oclif-tester plugins link PATH
oclif-tester plugins remove [PLUGIN]
oclif-tester plugins reset
oclif-tester plugins uninstall [PLUGIN]
oclif-tester plugins unlink [PLUGIN]
oclif-tester plugins update
oclif-tester hello PERSON
Say hello
USAGE
$ oclif-tester hello PERSON -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Who is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ oclif-tester hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
See code: src/commands/hello/index.ts
oclif-tester hello world
Say hello world
USAGE
$ oclif-tester hello world
DESCRIPTION
Say hello world
EXAMPLES
$ oclif-tester hello world
hello world! (./src/commands/hello/world.ts)
See code: src/commands/hello/world.ts
oclif-tester help [COMMAND]
Display help for oclif-tester.
USAGE
$ oclif-tester 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 oclif-tester.
See code: @oclif/plugin-help
oclif-tester plugins
List installed plugins.
USAGE
$ oclif-tester plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ oclif-tester plugins
See code: @oclif/plugin-plugins
oclif-tester plugins add PLUGIN
Installs a plugin into oclif-tester.
USAGE
$ oclif-tester 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 oclif-tester.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the OCLIF_TESTER_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the OCLIF_TESTER_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ oclif-tester plugins add
EXAMPLES
Install a plugin from npm registry.
$ oclif-tester plugins add myplugin
Install a plugin from a github url.
$ oclif-tester plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ oclif-tester plugins add someuser/someplugin
oclif-tester plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ oclif-tester 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
$ oclif-tester plugins inspect myplugin
See code: @oclif/plugin-plugins
oclif-tester plugins install PLUGIN
Installs a plugin into oclif-tester.
USAGE
$ oclif-tester 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 oclif-tester.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the OCLIF_TESTER_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the OCLIF_TESTER_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ oclif-tester plugins add
EXAMPLES
Install a plugin from npm registry.
$ oclif-tester plugins install myplugin
Install a plugin from a github url.
$ oclif-tester plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ oclif-tester plugins install someuser/someplugin
See code: @oclif/plugin-plugins
oclif-tester plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ oclif-tester 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
$ oclif-tester plugins link myplugin
See code: @oclif/plugin-plugins
oclif-tester plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ oclif-tester 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
$ oclif-tester plugins unlink
$ oclif-tester plugins remove
EXAMPLES
$ oclif-tester plugins remove myplugin
oclif-tester plugins reset
Remove all user-installed and linked plugins.
USAGE
$ oclif-tester 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
oclif-tester plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ oclif-tester 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
$ oclif-tester plugins unlink
$ oclif-tester plugins remove
EXAMPLES
$ oclif-tester plugins uninstall myplugin
See code: @oclif/plugin-plugins
oclif-tester plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ oclif-tester 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
$ oclif-tester plugins unlink
$ oclif-tester plugins remove
EXAMPLES
$ oclif-tester plugins unlink myplugin
oclif-tester plugins update
Update installed plugins.
USAGE
$ oclif-tester plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins