Skip to content

Latest commit

 

History

History
334 lines (236 loc) · 7.36 KB

README.md

File metadata and controls

334 lines (236 loc) · 7.36 KB
Raw

oclif-hello-world

oclif example Hello World CLI

oclif Version CircleCI Downloads/week License

Usage

$ npm install -g jminesweeper
$ jminesweeper COMMAND
running command...
$ jminesweeper (--version)
jminesweeper/0.0.0 darwin-arm64 node-v16.14.2
$ jminesweeper --help [COMMAND]
USAGE
  $ jminesweeper COMMAND
...

Commands

jminesweeper hello PERSON

Say hello

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

jminesweeper hello world

Say hello world

USAGE
  $ jminesweeper hello world

DESCRIPTION
  Say hello world

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

jminesweeper help [COMMAND]

Display help for jminesweeper.

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

See code: @oclif/plugin-help

jminesweeper plugins

List installed plugins.

USAGE
  $ jminesweeper plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ jminesweeper plugins

See code: @oclif/plugin-plugins

jminesweeper plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ jminesweeper plugins:install myplugin 

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

  $ jminesweeper plugins:install someuser/someplugin

jminesweeper plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

jminesweeper plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ jminesweeper plugins:install myplugin 

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

  $ jminesweeper plugins:install someuser/someplugin

jminesweeper plugins:link PLUGIN

Links a plugin into the CLI for development.

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

jminesweeper plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ jminesweeper plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ jminesweeper plugins unlink
  $ jminesweeper plugins remove

jminesweeper plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ jminesweeper plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ jminesweeper plugins unlink
  $ jminesweeper plugins remove

jminesweeper plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ jminesweeper plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ jminesweeper plugins unlink
  $ jminesweeper plugins remove

jminesweeper plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.