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