/ue-toolkit

Primary LanguageTypeScript

oclif-hello-world

oclif example Hello World CLI

oclif CircleCI GitHub license

Usage

$ npm install -g ue-toolkit
$ ue COMMAND
running command...
$ ue (--version)
ue-toolkit/0.0.0 win32-x64 node-v21.6.2
$ ue --help [COMMAND]
USAGE
  $ ue COMMAND
...
$ npm install -g oclif-hello-world
$ oex COMMAND
running command...
$ oex (--version)
oclif-hello-world/0.0.0 darwin-x64 node-v16.13.1
$ oex --help [COMMAND]
USAGE
  $ oex COMMAND
...

Commands

ue build PLATFORM TYPE CONFIG

Build cook run

USAGE
  $ ue build PLATFORM TYPE CONFIG [--cwd <value>] [-n <value>] [-p <value>]

ARGUMENTS
  PLATFORM  (android|windows|linux) Target platform
  TYPE      (client|server) Running type
  CONFIG    (test|debug|development|shipping) Running config

FLAGS
  -n, --androidDisplayName=<value>
  -p, --androidPackageName=<value>
  --cwd=<value>

DESCRIPTION
  Build cook run

See code: src/commands/build/index.ts

ue help [COMMANDS]

Display help for ue.

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

See code: @oclif/plugin-help

ue plugins

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ ue plugins

See code: @oclif/plugin-plugins

ue plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ ue plugins add plugins:install PLUGIN...

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -s, --silent   Silences yarn output.
  -v, --verbose  Show verbose yarn output.

GLOBAL FLAGS
  --json  Format output as json.

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
  $ ue plugins add

EXAMPLES
  $ ue plugins add myplugin 

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

  $ ue plugins add someuser/someplugin

ue plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

ue plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ ue plugins install PLUGIN...

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -s, --silent   Silences yarn output.
  -v, --verbose  Show verbose yarn output.

GLOBAL FLAGS
  --json  Format output as json.

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
  $ ue plugins add

EXAMPLES
  $ ue plugins install myplugin 

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

  $ ue plugins install someuser/someplugin

See code: @oclif/plugin-plugins

ue plugins:link PLUGIN

Links a plugin into the CLI for development.

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

See code: @oclif/plugin-plugins

ue plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ ue plugins remove plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ue plugins unlink
  $ ue plugins remove

EXAMPLES
  $ ue plugins remove myplugin

ue plugins reset

Remove all user-installed and linked plugins.

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

ue plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ ue plugins uninstall PLUGIN...

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ue plugins unlink
  $ ue plugins remove

EXAMPLES
  $ ue plugins uninstall myplugin

See code: @oclif/plugin-plugins

ue plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ ue plugins unlink plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ue plugins unlink
  $ ue plugins remove

EXAMPLES
  $ ue plugins unlink myplugin

ue plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

ue version up TYPE

Bump project version

USAGE
  $ ue version up TYPE [--android]

ARGUMENTS
  TYPE  (major|premajor|minor|preminor|patch|prepatch|prerelease) Type of version bumping

FLAGS
  --android

DESCRIPTION
  Bump project version

See code: src/commands/version/up.ts

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: dist/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)

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 [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ oex plugins

See code: @oclif/plugin-plugins

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

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ oex plugins:inspect myplugin

oex plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ oex plugins:install myplugin 

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

  $ oex plugins:install someuser/someplugin

oex plugins:link PLUGIN

Links a plugin into the CLI for development.

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

oex plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ oex plugins:uninstall PLUGIN...

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

oex plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.