z-scaffold v1.0.0

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g z-scaffold
$ z-scaffold COMMAND
running command...
$ z-scaffold (--version)
z-scaffold/1.0.0 darwin-x64 node-v18.14.0
$ z-scaffold --help [COMMAND]
USAGE
  $ z-scaffold COMMAND
...

Commands

• z-scaffold hello PERSON
• z-scaffold hello world
• z-scaffold help [COMMANDS]
• z-scaffold plugins
• z-scaffold plugins:install PLUGIN...
• z-scaffold plugins:inspect PLUGIN...
• z-scaffold plugins:install PLUGIN...
• z-scaffold plugins:link PLUGIN
• z-scaffold plugins:uninstall PLUGIN...
• z-scaffold plugins:uninstall PLUGIN...
• z-scaffold plugins:uninstall PLUGIN...
• z-scaffold plugins update

z-scaffold hello PERSON

Say hello

USAGE
  $ z-scaffold 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

z-scaffold hello world

Say hello world

USAGE
  $ z-scaffold hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ z-scaffold hello world
  hello world! (./src/commands/hello/world.ts)

See code: dist/commands/hello/world.ts

z-scaffold help [COMMANDS]

Display help for z-scaffold.

USAGE
  $ z-scaffold 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 z-scaffold.

See code: @oclif/plugin-help

z-scaffold plugins

List installed plugins.

USAGE
  $ z-scaffold plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ z-scaffold plugins

See code: @oclif/plugin-plugins

z-scaffold plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ z-scaffold plugins:install myplugin 

  $ z-scaffold plugins:install https://github.com/someuser/someplugin

  $ z-scaffold plugins:install someuser/someplugin

z-scaffold plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

z-scaffold plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ z-scaffold plugins:install myplugin 

  $ z-scaffold plugins:install https://github.com/someuser/someplugin

  $ z-scaffold plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

z-scaffold plugins:link PLUGIN

Links a plugin into the CLI for development.

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

See code: @oclif/plugin-plugins

z-scaffold plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ z-scaffold plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ z-scaffold plugins unlink
  $ z-scaffold plugins remove

z-scaffold plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ z-scaffold plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ z-scaffold plugins unlink
  $ z-scaffold plugins remove

See code: @oclif/plugin-plugins

z-scaffold plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ z-scaffold plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ z-scaffold plugins unlink
  $ z-scaffold plugins remove

z-scaffold plugins update

Update installed plugins.

USAGE
  $ z-scaffold plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins