Skip to content

Latest commit

 

History

History
237 lines (168 loc) · 5.75 KB

README.md

File metadata and controls

237 lines (168 loc) · 5.75 KB
Raw

oclif-hello-world

oclif example Hello World CLI

oclif CircleCI GitHub license

Usage

$ npm install -g @oclif/plugin-test-pre-core
$ pre-core COMMAND
running command...
$ pre-core (--version)
@oclif/plugin-test-pre-core/0.4.16 linux-x64 node-v18.20.4
$ pre-core --help [COMMAND]
USAGE
  $ pre-core COMMAND
...

Commands

pre-core help [COMMANDS]

Display help for pre-core.

USAGE
  $ pre-core 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 pre-core.

See code: @oclif/plugin-help

pre-core plugins

List installed plugins.

USAGE
  $ pre-core plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ pre-core plugins

See code: @oclif/plugin-plugins

pre-core plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

pre-core plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ pre-core plugins:install myplugin 

  $ pre-core plugins:install https://github.com/someuser/someplugin

  $ pre-core plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

pre-core plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ pre-core plugins:link PLUGIN

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
  $ pre-core plugins:link myplugin

See code: @oclif/plugin-plugins

pre-core plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ pre-core plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ pre-core plugins unlink
  $ pre-core plugins remove

See code: @oclif/plugin-plugins

pre-core plugins update

Update installed plugins.

USAGE
  $ pre-core plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

pre-core pre-core [OPTIONALARG] [DEFAULTARG] [DEFAULTFNARG]

USAGE
  $ pre-core pre-core [OPTIONALARG] [DEFAULTARG] [DEFAULTFNARG] [--optionalString <value>] [--defaultString
    <value>] [--defaultFnString <value>] [--json]

FLAGS
  --defaultFnString=<value>  [default: fn default]
  --defaultString=<value>    [default: simple string default]
  --json
  --optionalString=<value>

See code: src/commands/pre-core.ts