oclif-hello-world-esm v0.4.32

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g oclif-hello-world-esm
$ oex COMMAND
running command...
$ oex (--version)
oclif-hello-world-esm/0.4.32 linux-x64 node-v20.12.2
$ oex --help [COMMAND]
USAGE
  $ oex COMMAND
...

Commands

• oex hello PERSON
• oex hello world
• oex help [COMMAND]
• oex plugins
• oex plugins add PLUGIN
• oex plugins:inspect PLUGIN...
• oex plugins install PLUGIN
• oex plugins link PATH
• oex plugins remove [PLUGIN]
• oex plugins reset
• oex plugins uninstall [PLUGIN]
• oex plugins unlink [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: src/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)

See code: 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 [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ oex plugins

See code: @oclif/plugin-plugins

oex plugins add PLUGIN

Installs a plugin into oex.

USAGE
  $ oex 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 oex.

  Uses bundled npm executable to install plugins into /home/runner/.local/share/oex

  Installation of a user-installed plugin will override a core plugin.

  Use the OEX_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the OEX_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ oex plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ oex plugins add myplugin

  Install a plugin from a github url.

    $ oex plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ oex plugins add someuser/someplugin

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

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ oex plugins inspect myplugin

See code: @oclif/plugin-plugins

oex plugins install PLUGIN

Installs a plugin into oex.

USAGE
  $ oex 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 oex.

  Uses bundled npm executable to install plugins into /home/runner/.local/share/oex

  Installation of a user-installed plugin will override a core plugin.

  Use the OEX_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the OEX_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ oex plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ oex plugins install myplugin

  Install a plugin from a github url.

    $ oex plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ oex plugins install someuser/someplugin

See code: @oclif/plugin-plugins

oex plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ oex 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
  $ oex plugins link myplugin

See code: @oclif/plugin-plugins

oex plugins remove [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ oex plugins remove myplugin

oex plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ oex 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

oex plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ oex plugins uninstall myplugin

See code: @oclif/plugin-plugins

oex plugins unlink [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ oex plugins unlink myplugin

oex plugins update

Update installed plugins.

USAGE
  $ oex plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins