oclif-hello-world

oclif example Hello World CLI

• oclif-hello-world
• Usage
• Commands

Usage

$ npm install -g @storengine/cli
$ storengine COMMAND
running command...
$ storengine (--version)
@storengine/cli/0.0.9 darwin-arm64 node-v18.15.0
$ storengine --help [COMMAND]
USAGE
  $ storengine COMMAND
...

Commands

• storengine cross-acc
• storengine help [COMMANDS]
• storengine init USERNAME TEMPLATEID
• storengine plugins
• storengine plugins:install PLUGIN...
• storengine plugins:inspect PLUGIN...
• storengine plugins:install PLUGIN...
• storengine plugins:link PLUGIN
• storengine plugins:uninstall PLUGIN...
• storengine plugins:uninstall PLUGIN...
• storengine plugins:uninstall PLUGIN...
• storengine plugins update

storengine cross-acc

USAGE
  $ storengine cross-acc

See code: dist/commands/cross-acc.ts

storengine help [COMMANDS]

Display help for storengine.

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

See code: @oclif/plugin-help

storengine init USERNAME TEMPLATEID

Creates an upload demo in your project, consisting of an API route and page component.

USAGE
  $ storengine init USERNAME TEMPLATEID

ARGUMENTS
  USERNAME    Your username
  TEMPLATEID  The ID of the template to use

DESCRIPTION
  Creates an upload demo in your project, consisting of an API route and page component.

See code: dist/commands/init/index.ts

storengine plugins

List installed plugins.

USAGE
  $ storengine plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ storengine plugins

See code: @oclif/plugin-plugins

storengine plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ storengine plugins:install myplugin 

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

  $ storengine plugins:install someuser/someplugin

storengine plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

storengine plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ storengine plugins:install myplugin 

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

  $ storengine plugins:install someuser/someplugin

storengine plugins:link PLUGIN

Links a plugin into the CLI for development.

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

storengine plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ storengine plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ storengine plugins unlink
  $ storengine plugins remove

storengine plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ storengine plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ storengine plugins unlink
  $ storengine plugins remove

storengine plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ storengine plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ storengine plugins unlink
  $ storengine plugins remove

storengine plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.