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