oclif example Hello World CLI
$ npm install -g hash
$ hash COMMAND
running command...
$ hash (--version)
hash/0.0.0 linux-x64 node-v18.12.1
$ hash --help [COMMAND]
USAGE
$ hash COMMAND
...
hash hello PERSON
hash hello world
hash help [COMMANDS]
hash plugins
hash plugins:install PLUGIN...
hash plugins:inspect PLUGIN...
hash plugins:install PLUGIN...
hash plugins:link PLUGIN
hash plugins:uninstall PLUGIN...
hash plugins:uninstall PLUGIN...
hash plugins:uninstall PLUGIN...
hash plugins update
Say hello
USAGE
$ hash hello PERSON -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Who is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ oex hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
See code: dist/commands/hello/index.ts
Say hello world
USAGE
$ hash hello world
DESCRIPTION
Say hello world
EXAMPLES
$ hash hello world
hello world! (./src/commands/hello/world.ts)
Display help for hash.
USAGE
$ hash 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 hash.
See code: @oclif/plugin-help
List installed plugins.
USAGE
$ hash plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ hash plugins
See code: @oclif/plugin-plugins
Installs a plugin into the CLI.
USAGE
$ hash 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
$ hash plugins add
EXAMPLES
$ hash plugins:install myplugin
$ hash plugins:install https://github.com/someuser/someplugin
$ hash plugins:install someuser/someplugin
Displays installation properties of a plugin.
USAGE
$ hash 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
$ hash plugins:inspect myplugin
Installs a plugin into the CLI.
USAGE
$ hash 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
$ hash plugins add
EXAMPLES
$ hash plugins:install myplugin
$ hash plugins:install https://github.com/someuser/someplugin
$ hash plugins:install someuser/someplugin
Links a plugin into the CLI for development.
USAGE
$ hash 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
$ hash plugins:link myplugin
Removes a plugin from the CLI.
USAGE
$ hash plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ hash plugins unlink
$ hash plugins remove
Removes a plugin from the CLI.
USAGE
$ hash plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ hash plugins unlink
$ hash plugins remove
Removes a plugin from the CLI.
USAGE
$ hash plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ hash plugins unlink
$ hash plugins remove
Update installed plugins.
USAGE
$ hash plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.