bc-email-builder

A BigCommerce Email Builder CLI Tool for downloading and publishing email templates.

• bc-email-builder
• Usage
• Commands

Usage

$ npm install -g @andrewbarber/bc-email-builder
$ email-builder COMMAND
running command...
$ email-builder (--version)
@andrewbarber/bc-email-builder/0.2.3 linux-x64 node-v18.20.3
$ email-builder --help [COMMAND]
USAGE
  $ email-builder COMMAND
...

Commands

• email-builder download [EMAIL-TEMPLATE]
• email-builder help [COMMAND]
• email-builder init
• email-builder plugins
• email-builder plugins add PLUGIN
• email-builder plugins:inspect PLUGIN...
• email-builder plugins install PLUGIN
• email-builder plugins link PATH
• email-builder plugins remove [PLUGIN]
• email-builder plugins reset
• email-builder plugins uninstall [PLUGIN]
• email-builder plugins unlink [PLUGIN]
• email-builder plugins update
• email-builder publish [EMAIL-TEMPLATE]

email-builder download [EMAIL-TEMPLATE]

Download the email templates from the storefront

USAGE
  $ email-builder download [EMAIL-TEMPLATE] -p <value> [-o]

ARGUMENTS
  EMAIL-TEMPLATE  [default: all] Email template to download from store

FLAGS
  -o, --overwrite     Overwrite existing email templates
  -p, --path=<value>  (required) [default: .] Path to save the email template

DESCRIPTION
  Download the email templates from the storefront

EXAMPLES
  Download the abandoned cart email template to the email directory

    $ email-builder download abandoned_cart_email --path ./email

  Download all email templates to the email directory and overwrite existing templates

    $ email-builder download all --path ./email -o

See code: src/commands/download.ts

email-builder help [COMMAND]

Display help for email-builder.

USAGE
  $ email-builder 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 email-builder.

See code: @oclif/plugin-help

email-builder init

Initialize the environment variables for the email builder.

USAGE
  $ email-builder init [-t <value>] [-c <value>] [-i <value>] [-h <value>]

FLAGS
  -c, --channelId=<value>    Channel ID for the storefront (Default: All Channels)
  -h, --storeHash=<value>    Store Hash for the storefront
  -i, --clientId=<value>     Client ID for the API Token
  -t, --accessToken=<value>  Access Token for the API Token

DESCRIPTION
  Initialize the environment variables for the email builder.

  Before continuing, please make sure you've created or received a Store API account.
  You'll need those credentials in order to generate the appropriate configurations.
  The scope you'll need is: Information & Settings (Modify).	
  You can find more information here. https://support.bigcommerce.com/s/article/Store-API-Accounts#creating


EXAMPLES
  Run the command in interactive mode

    $ email-builder init

  Run the command with flags (perfect for CI/CD)

    $ email-builder init --channelId 1 --storeHash jk0h5oo6h0 --clientId 1234567890 --accessToken 1234567890abcdefg

See code: src/commands/init.ts

email-builder plugins

List installed plugins.

USAGE
  $ email-builder plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ email-builder plugins

See code: @oclif/plugin-plugins

email-builder plugins add PLUGIN

Installs a plugin into email-builder.

USAGE
  $ email-builder 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 email-builder.

  Uses npm to install plugins.

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

  Use the EMAIL_BUILDER_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the EMAIL_BUILDER_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ email-builder plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ email-builder plugins add myplugin

  Install a plugin from a github url.

    $ email-builder plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ email-builder plugins add someuser/someplugin

email-builder plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

email-builder plugins install PLUGIN

Installs a plugin into email-builder.

USAGE
  $ email-builder 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 email-builder.

  Uses npm to install plugins.

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

  Use the EMAIL_BUILDER_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the EMAIL_BUILDER_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ email-builder plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ email-builder plugins install myplugin

  Install a plugin from a github url.

    $ email-builder plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ email-builder plugins install someuser/someplugin

See code: @oclif/plugin-plugins

email-builder plugins link PATH

Links a plugin into the CLI for development.

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

See code: @oclif/plugin-plugins

email-builder plugins remove [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ email-builder plugins remove myplugin

email-builder plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ email-builder 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

email-builder plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ email-builder plugins uninstall myplugin

See code: @oclif/plugin-plugins

email-builder plugins unlink [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ email-builder plugins unlink myplugin

email-builder plugins update

Update installed plugins.

USAGE
  $ email-builder plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

email-builder publish [EMAIL-TEMPLATE]

describe the command here

USAGE
  $ email-builder publish [EMAIL-TEMPLATE] -p <value>

ARGUMENTS
  EMAIL-TEMPLATE  [default: all] Email template to publish to the store

FLAGS
  -p, --path=<value>  (required) [default: .] Path to save the email template

DESCRIPTION
  describe the command here

EXAMPLES
  $ email-builder publish

See code: src/commands/publish.ts