genstuff v0.0.0-alpha.17

oclif-hello-world

oclif example Hello World CLI

• oclif-hello-world
• Usage
• Commands

Usage

$ npm install -g genstuff
$ genstuff COMMAND
running command...
$ genstuff (--version)
genstuff/0.0.0-alpha.17 linux-x64 node-v18.14.2
$ genstuff --help [COMMAND]
USAGE
  $ genstuff COMMAND
...

Commands

• genstuff gen [COMPONENTNAME]
• genstuff help [COMMANDS]
• genstuff plugins
• genstuff plugins:install PLUGIN...
• genstuff plugins:inspect PLUGIN...
• genstuff plugins:install PLUGIN...
• genstuff plugins:link PLUGIN
• genstuff plugins:uninstall PLUGIN...
• genstuff plugins:uninstall PLUGIN...
• genstuff plugins:uninstall PLUGIN...
• genstuff plugins update

genstuff gen [COMPONENTNAME]

describe the command here

USAGE
  $ genstuff gen [COMPONENTNAME] [-p <value>] [-s] [-D] [-P <value>] [-e <value>] [-f] [-x <value>]
    [--display <value>] [--test] [--ref] [--no-variants] [--no-config] [--no-type] [--in-place] [--no-display]
    [--pretty]

ARGUMENTS
  COMPONENTNAME  file to read

FLAGS
  -D, --defaultExport
  -P, --path=<value>    [default: ui]
  -e, --extend=<value>
  -f, --force
  -p, --props=<value>
  -s, --stories
  -x, --cvax=<value>
  --display=<value>
  --in-place
  --no-config
  --no-display
  --no-type
  --no-variants
  --pretty
  --ref
  --test

DESCRIPTION
  describe the command here

EXAMPLES
  $ genstuff gen

See code: dist/commands/gen.ts

genstuff help [COMMANDS]

Display help for genstuff.

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

See code: @oclif/plugin-help

genstuff plugins

List installed plugins.

USAGE
  $ genstuff plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ genstuff plugins

See code: @oclif/plugin-plugins

genstuff plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ genstuff plugins:install myplugin 

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

  $ genstuff plugins:install someuser/someplugin

genstuff plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

genstuff plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ genstuff plugins:install myplugin 

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

  $ genstuff plugins:install someuser/someplugin

genstuff plugins:link PLUGIN

Links a plugin into the CLI for development.

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

genstuff plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ genstuff plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ genstuff plugins unlink
  $ genstuff plugins remove

genstuff plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ genstuff plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ genstuff plugins unlink
  $ genstuff plugins remove

genstuff plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ genstuff plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ genstuff plugins unlink
  $ genstuff plugins remove

genstuff plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.