_/oclif/README.md

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g hello-world
$ hello-world COMMAND
running command...
$ hello-world (--version)
hello-world/0.0.0 linux-x64 node-v16.14.2
$ hello-world --help [COMMAND]
USAGE
  $ hello-world COMMAND
...

Commands

• hello-world hello PERSON
• hello-world hello world
• hello-world help [COMMAND]
• hello-world plugins
• hello-world plugins:install PLUGIN...
• hello-world plugins:inspect PLUGIN...
• hello-world plugins:install PLUGIN...
• hello-world plugins:link PLUGIN
• hello-world plugins:uninstall PLUGIN...
• hello-world plugins:uninstall PLUGIN...
• hello-world plugins:uninstall PLUGIN...
• hello-world plugins update

hello-world hello PERSON

Say hello

USAGE
  $ hello-world 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

hello-world hello world

Say hello world

USAGE
  $ hello-world hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ oex hello world
  hello world! (./src/commands/hello/world.ts)

hello-world help [COMMAND]

Display help for hello-world.

USAGE
  $ hello-world 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 hello-world.

See code: @oclif/plugin-help

hello-world plugins

List installed plugins.

USAGE
  $ hello-world plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ hello-world plugins

See code: @oclif/plugin-plugins

hello-world plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ hello-world 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-world plugins add

EXAMPLES
  $ hello-world plugins:install myplugin 

  $ hello-world plugins:install https://github.com/someuser/someplugin

  $ hello-world plugins:install someuser/someplugin

hello-world plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ hello-world 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
  $ hello-world plugins:inspect myplugin

hello-world plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ hello-world 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-world plugins add

EXAMPLES
  $ hello-world plugins:install myplugin 

  $ hello-world plugins:install https://github.com/someuser/someplugin

  $ hello-world plugins:install someuser/someplugin

hello-world plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ hello-world 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-world plugins:link myplugin

hello-world plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ hello-world 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-world plugins unlink
  $ hello-world plugins remove

hello-world plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ hello-world 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-world plugins unlink
  $ hello-world plugins remove

hello-world plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ hello-world 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-world plugins unlink
  $ hello-world plugins remove

hello-world plugins update

Update installed plugins.

USAGE
  $ hello-world plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.