@userstorybook/cli v0.0.1

User Story Book CLI

Generate a static site to navigate and review your business logic.

• Usage
• Commands

Usage

$ npm install -g @userstorybook/cli
$ usb COMMAND
running command...
$ usb (--version)
@userstorybook/cli/0.0.1 darwin-arm64 node-v18.8.0
$ usb --help [COMMAND]
USAGE
  $ usb COMMAND
...

Commands

• usb build [FILE]
• usb help [COMMAND]
• usb plugins
• usb plugins:install PLUGIN...
• usb plugins:inspect PLUGIN...
• usb plugins:install PLUGIN...
• usb plugins:link PLUGIN
• usb plugins:uninstall PLUGIN...
• usb plugins:uninstall PLUGIN...
• usb plugins:uninstall PLUGIN...
• usb plugins update

usb build [FILE]

Builds your user storybook according to your configuration.

USAGE
  $ usb build [FILE] [-c <value>] [-d <value>] [-o <value>] [-f] [-v] [--jsonOnly]

FLAGS
  -c, --config=<value>     [default: .userstorybook.json] Path to configuration file
  -d, --directory=<value>  Path to project directory (useful for testing)
  -f, --force
  -o, --output=<value>     [default: .userstorybook] Path to storybook output directory
  -v, --verbose
  --jsonOnly

DESCRIPTION
  Builds your user storybook according to your configuration.

EXAMPLES
  $ usb build

See code: dist/commands/build.ts

usb help [COMMAND]

Display help for usb.

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

See code: @oclif/plugin-help

usb plugins

List installed plugins.

USAGE
  $ usb plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ usb plugins

See code: @oclif/plugin-plugins

usb plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ usb plugins:install myplugin 

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

  $ usb plugins:install someuser/someplugin

usb plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

usb plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ usb plugins:install myplugin 

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

  $ usb plugins:install someuser/someplugin

usb plugins:link PLUGIN

Links a plugin into the CLI for development.

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

usb plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ usb plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ usb plugins unlink
  $ usb plugins remove

usb plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ usb plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ usb plugins unlink
  $ usb plugins remove

usb plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ usb plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ usb plugins unlink
  $ usb plugins remove

usb plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.