sybit-c4cli

A command line tool to automate some tasks in C3 Commerce

• sybit-c4cli
• Usage
• Commands

Usage

$ npm install -g @sybit/c4cli
$ c4 COMMAND
running command...
$ c4 (--version)
@sybit/c4cli/1.0.6 linux-x64 node-v20.14.0
$ c4 --help [COMMAND]
USAGE
  $ c4 COMMAND
...

Commands

• c4 help [COMMAND]
• c4 plugins
• c4 plugins add PLUGIN
• c4 plugins:inspect PLUGIN...
• c4 plugins install PLUGIN
• c4 plugins link PATH
• c4 plugins remove [PLUGIN]
• c4 plugins reset
• c4 plugins uninstall [PLUGIN]
• c4 plugins unlink [PLUGIN]
• c4 plugins update
• c4 prepare [CUSTOMER]
• c4 update [CHANNEL]

c4 help [COMMAND]

Display help for c4.

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

See code: @oclif/plugin-help

c4 plugins

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ c4 plugins

See code: @oclif/plugin-plugins

c4 plugins add PLUGIN

Installs a plugin into c4.

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

  Uses npm to install plugins.

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

  Use the C4_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the C4_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ c4 plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ c4 plugins add myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ c4 plugins add someuser/someplugin

c4 plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

c4 plugins install PLUGIN

Installs a plugin into c4.

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

  Uses npm to install plugins.

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

  Use the C4_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the C4_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ c4 plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ c4 plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ c4 plugins install someuser/someplugin

See code: @oclif/plugin-plugins

c4 plugins link PATH

Links a plugin into the CLI for development.

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

See code: @oclif/plugin-plugins

c4 plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ c4 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
  $ c4 plugins unlink
  $ c4 plugins remove

EXAMPLES
  $ c4 plugins remove myplugin

c4 plugins reset

Remove all user-installed and linked plugins.

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

c4 plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ c4 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
  $ c4 plugins unlink
  $ c4 plugins remove

EXAMPLES
  $ c4 plugins uninstall myplugin

See code: @oclif/plugin-plugins

c4 plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ c4 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
  $ c4 plugins unlink
  $ c4 plugins remove

EXAMPLES
  $ c4 plugins unlink myplugin

c4 plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

c4 prepare [CUSTOMER]

setup commerce cloud projects based on customer slug or topic in gitlab

USAGE
  $ c4 prepare [CUSTOMER] -h <value> -g <value> -p <value> [-c <value>] [-f] [-t <value>]

ARGUMENTS
  CUSTOMER  slug of the customer in gitlab. if empty all projects found in the topic will be processed

FLAGS
  -c, --concurrency=<value>  [default: 4] How many project should be processed in parallel (ENV: CONCURRENCY)
  -f, --failFast             fail on the first error instead of collecting all errors
  -g, --gitlabToken=<value>  (required) personal access token with api scope (ENV: GITLAB_TOKEN)
  -h, --gitlabHost=<value>   (required) [default: https://gitlab.sybit.dev/] base url of the gitlab instance (ENV:
                             GITLAB_HOST)
  -p, --projectsDir=<value>  (required) [default: /root/projects] directory to store the projects in (ENV: PROJECTS_DIR)
  -t, --gitlabTopic=<value>  [default: continuous-customer-care] gitlab topic to search for projects to prepare (ENV:
                             GITLAB_TOPIC)

DESCRIPTION
  setup commerce cloud projects based on customer slug or topic in gitlab

EXAMPLES
  $ c4 prepare

  $ c4 prepare multivac

  $ c4 prepare -t Commerce-Project

c4 update [CHANNEL]

update the c4 CLI

USAGE
  $ c4 update [CHANNEL] [--force |  | [-a | -v <value> | -i]]

FLAGS
  -a, --available        See available versions.
  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
  -v, --version=<value>  Install a specific version.
      --force            Force a re-download of the requested version.

DESCRIPTION
  update the c4 CLI

EXAMPLES
  Update to the stable channel:

    $ c4 update stable

  Update to a specific version:

    $ c4 update --version 1.0.0

  Interactively select version:

    $ c4 update --interactive

  See available versions:

    $ c4 update --available

See code: @oclif/plugin-update