Skip to content

README.md

Latest commit

 

History

History
397 lines (272 loc) · 8.27 KB

README.md

File metadata and controls

397 lines (272 loc) · 8.27 KB

@salesforce/b2c-cli

A Salesforce Commerce Cloud B2C CLI

oclif Version Downloads/week

Usage

$ npm install -g @salesforce/b2c-cli
$ b2c COMMAND
running command...
$ b2c (--version)
@salesforce/b2c-cli/0.0.0 darwin-arm64 node-v22.20.0
$ b2c --help [COMMAND]
USAGE
  $ b2c COMMAND
...

Commands

b2c hello PERSON

Say hello

USAGE
  $ b2c hello PERSON -f <value>

ARGUMENTS
  PERSON  Person to say hello to

FLAGS
  -f, --from=<value>  (required) Who is saying hello

DESCRIPTION
  Say hello

EXAMPLES
  $ b2c hello friend --from oclif
  hello friend from oclif! (./src/commands/hello/index.ts)

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

b2c hello world

Say hello world

USAGE
  $ b2c hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ b2c hello world
  hello world! (./src/commands/hello/world.ts)

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

b2c help [COMMAND]

Display help for b2c.

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

See code: @oclif/plugin-help

b2c plugins

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ b2c plugins

See code: @oclif/plugin-plugins

b2c plugins add PLUGIN

Installs a plugin into b2c.

USAGE
  $ b2c plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into b2c.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the B2C_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the B2C_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ b2c plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ b2c plugins add myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ b2c plugins add someuser/someplugin

b2c plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

b2c plugins install PLUGIN

Installs a plugin into b2c.

USAGE
  $ b2c plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into b2c.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the B2C_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the B2C_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ b2c plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ b2c plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ b2c plugins install someuser/someplugin

See code: @oclif/plugin-plugins

b2c plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ b2c plugins link PATH [-h] [--install] [-v]

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

See code: @oclif/plugin-plugins

b2c plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ b2c plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  [PLUGIN...]  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ b2c plugins unlink
  $ b2c plugins remove

EXAMPLES
  $ b2c plugins remove myplugin

b2c plugins reset

Remove all user-installed and linked plugins.

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

b2c plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ b2c plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  [PLUGIN...]  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ b2c plugins unlink
  $ b2c plugins remove

EXAMPLES
  $ b2c plugins uninstall myplugin

See code: @oclif/plugin-plugins

b2c plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ b2c plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  [PLUGIN...]  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ b2c plugins unlink
  $ b2c plugins remove

EXAMPLES
  $ b2c plugins unlink myplugin

b2c plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins