SF服务编织>> commerce-on-lightning>> 返回
项目作者： forcedotcom

项目描述 ：
An SFDX Plugin to setup a B2C or B2B Store
高级语言： TypeScript
项目地址: git://github.com/forcedotcom/commerce-on-lightning.git
创建时间： 2021-06-14T16:55:59Z
项目社区：https://github.com/forcedotcom/commerce-on-lightning
开源协议：BSD 3-Clause "New" or "Revised" License
下载


commerce-on-lightning

@salesforce/commerce"">Version
Appveyor CI
Codecov
Known Vulnerabilities
@salesforce/commerce"">Downloads/week
License

Commerce commands for Salesforce CLI.

If you want a store, for test or any other purposes, then use this plugin to automate all steps required.
It has built in automation to help if any steps fail. This plugin is designed to be as hands off as possible.

This plugin is used to create and setup either a B2B or a B2C store with data with as little effort as possible.

This plugin requires the Salesforce CLI. For more information on the CLI, read the getting started guide.

We always recommend using the latest version of these commands, however, you can install a specific version or tag if needed.

Introduction

This plugin is designed to setup a test store either B2B or B2C within a scratch org. It will add products and
users, a guest user, admin user and buyer user.
This plugin assumes your devhub and scratchorg are already setup.

This repo also contains example components for your store you can load after the fact.

For B2C examples components please see:
B2B2C Advanced Reference Components

For B2B examples components please see:
B2B Advanced Reference Components

Usage

  1. $ npm install -g @salesforce/commerce
  2. $ sf COMMAND
  3. running command...
  4. $ sf (-v|--version|version)
  5. @salesforce/commerce/252.0.1 darwin-arm64 node-v18.20.1
  6. $ sf --help [COMMAND]
  7. USAGE
  8.   $ sf COMMAND
  9. ...

Install

  1. sf plugins:install @salesforce/commerce

Issues

Please report any issues at https://github.com/forcedotcom/commerce-on-lightning/issues

Contributing

Please see our CONTRIBUTING guide.

Build

If you plan to help develop the plugin then these steps are for you.

To build the plugin locally, make sure to have yarn installed and run the following commands:

  1. # Clone the repository
  2. git clone git@github.com:forcedotcom/commerce-on-lightning.git
  4. # Install the dependencies and compile
  5. yarn install
  6. yarn build

To use your plugin, run using the local ./bin/run or ./bin/run.cmd file. This is helpful for mostly debugging
purposes as you can add this command to an IDE.

  1. # Run using local run file.
  2. ./bin/run commerce:store:create

There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.

  1. # Link your plugin to the sf cli
  2. sf plugins:link .
  3. # To verify
  4. sf plugins

Commands

sf commerce:examples:convert -f <filepath> -n <string> [-d <string>] [-p <string>] [-o <string>] [-y] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Convert repo examples to SFDX scratch org

  1. USAGE
  2.   $ sf commerce:examples:convert -f <filepath> -n <string> [-d <string>] [-p <string>] [-o <string>] [-y] [--json]
  3.   [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
  5. OPTIONS
  6.   -d, --outputdir=outputdir                                                         [default: ~/.commerc
  7.                                                                                     e/force-app] Directory to output the
  8.                                                                                     conversion
  10.   -f, --definitionfile=definitionfile                                               (required) config file
  12.   -n, --store-name=store-name                                                       (required) [default: 1commerce]
  13.                                                                                     Store name
  15.   -o, --type=b2c|b2b                                                                The type of store you want to create
  17.   -p, --sourcepath=sourcepath                                                       Files to convert
  19.   -y, --prompt                                                                      If there is a file difference
  20.                                                                                     detected, prompt before overwriting
  21.                                                                                     file
  23.   --json                                                                            format output as json
  25.   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
  26.                                                                                     this command invocation
  28. EXAMPLE
  29.   sf commerce:examples:convert -f store-scratch-def.json

See code: src/commands/commerce/examples/convert.ts

sf commerce:extension:map [-r <string>] [-n <string>] [-i <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Maps an extension to a specific webstore

  1. USAGE
  2.   $ sf commerce:extension:map [-r <string>] [-n <string>] [-i <string>] [-u <string>] [--apiversion <string>] [--json]
  3.    [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
  5. OPTIONS
  6.   -i, --store-id=store-id                                                           Optional webstore ID flag
  8.   -n, --store-name=store-name                                                       The name of the webstore to map the
  9.                                                                                     extension
  11.   -r, --registered-extension-name=registered-extension-name                         Unique name for extension
  13.   -u, --targetusername=targetusername                                               username or alias for the target
  14.                                                                                     org; overrides default target org
  16.   --apiversion=apiversion                                                           override the api version used for
  17.                                                                                     api requests made by this command
  19.   --json                                                                            format output as json
  21.   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
  22.                                                                                     this command invocation
  24. EXAMPLES
  25.   sf commerce:extension:map --registered-extension-name test-extension-name --store-name test-store-name
  26.   sf commerce:extension:map --registered-extension-name test-extension-name --store-id test-store-id

See code: src/commands/commerce/extension/map.ts

sf commerce:extension:points:list [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Lists all EPN values

  1. USAGE
  2.   $ sf commerce:extension:points:list [-u <string>] [--apiversion <string>] [--json] [--loglevel
  3.   trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
  5. OPTIONS
  6.   -u, --targetusername=targetusername                                               username or alias for the target
  7.                                                                                     org; overrides default target org
  9.   --apiversion=apiversion                                                           override the api version used for
  10.                                                                                     api requests made by this command
  12.   --json                                                                            format output as json
  14.   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
  15.                                                                                     this command invocation
  17. EXAMPLE
  18.   sf commerce:extension:getEPN

See code: src/commands/commerce/extension/points/list.ts

sf commerce:extension:register [-r <string>] [-e <string>] [-a <string>] [-m <string>] [-d <string>] [--icon-uri <string>] [--is-application] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Register an extension with one command

  1. USAGE
  2.   $ sf commerce:extension:register [-r <string>] [-e <string>] [-a <string>] [-m <string>] [-d <string>] [--icon-uri
  3.   <string>] [--is-application] [-u <string>] [--apiversion <string>] [--json] [--loglevel
  4.   trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
  6. OPTIONS
  7.   -a, --apex-class-name=apex-class-name
  8.       Name of the Apex class that needs to be extended
  10.   -d, --description=description
  11.       A brief description of the extension
  13.   -e, --extension-point-name=extension-point-name
  14.       Means of identifying entry points within the domain code that are capable of being extended by partners.Takes the
  15.       form domain_sub-domain_interface. E.g: checkout_summary_computeTax
  17.   -m, --apex-namespace=apex-namespace
  18.       Optional namespace for apex class
  20.   -r, --registered-extension-name=registered-extension-name
  21.       Unique name for extension
  23.   -u, --targetusername=targetusername
  24.       username or alias for the target org; overrides default target org
  26.   --apiversion=apiversion
  27.       override the api version used for api requests made by this command
  29.   --icon-uri=icon-uri
  30.       Where to find the icon representing the extension in URI form.
  32.   --is-application
  33.       A boolean that indicates if the extension provider is contained within a managed package
  35.   --json
  36.       format output as json
  38.   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)
  39.       [default: warn] logging level for this command invocation
  41. EXAMPLE
  42.   sf commerce:extension:register --registered-extension-name test-extension-name --extension-point-name test-epn
  43.   --apex-class-name test-apex-class

See code: src/commands/commerce/extension/register.ts

sf commerce:extension:unmap [-r <string>] [-n <string>] [-i <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Unmaps an extension from a store

  1. USAGE
  2.   $ sf commerce:extension:unmap [-r <string>] [-n <string>] [-i <string>] [-u <string>] [--apiversion <string>]
  3.   [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
  5. OPTIONS
  6.   -i, --store-id=store-id                                                           Optional webstore ID flag
  8.   -n, --store-name=store-name                                                       The name of the webstore to map the
  9.                                                                                     extension
  11.   -r, --registered-extension-name=registered-extension-name                         Unique name for extension
  13.   -u, --targetusername=targetusername                                               username or alias for the target
  14.                                                                                     org; overrides default target org
  16.   --apiversion=apiversion                                                           override the api version used for
  17.                                                                                     api requests made by this command
  19.   --json                                                                            format output as json
  21.   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
  22.                                                                                     this command invocation
  24. EXAMPLES
  25.   sf commerce:extension:unmap --registered-extension-name test-extension-name --store-name test-store-name
  26.   sf commerce:extension:unmap --registered-extension-name test-extension-name --store-id test-store-id

See code: src/commands/commerce/extension/unmap.ts

sf commerce:files:copy [name=value...] --filestocopy <array> --dirstocopy <array> --copysourcepath <string> [-y] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Copy files from source to destination folder ~/.commerce

  1. USAGE
  2.   $ sf commerce:files:copy [name=value...] --filestocopy <array> --dirstocopy <array> --copysourcepath <string> [-y]
  3.   [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
  5. OPTIONS
  6.   -y, --prompt                                                                      If there is a file difference
  7.                                                                                     detected, prompt before overwriting
  8.                                                                                     file
  10.   --copysourcepath=copysourcepath                                                   (required) Base path for files and
  11.                                                                                     directories to be copied from
  13.   --dirstocopy=dirstocopy                                                           (required) Array of directories
  14.                                                                                     (including their contents) located
  15.                                                                                     in source directory to copy
  17.   --filestocopy=filestocopy                                                         (required) Array of individual files
  18.                                                                                     to copy located directly in source
  19.                                                                                     directory
  21.   --json                                                                            format output as json
  23.   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
  24.                                                                                     this command invocation
  26. EXAMPLES
  27.   sf commerce:files:copy -y --copySourcePath "~/myexamplefilesdirectory" --filestocopy "file1.txt,file2.txt"
  28.   --dirstocopy "dir1,dir2,dir3"
  29.   sf commerce:files:copy --prompt --copySourcePath "~/myexamplefilesdirectory" --filestocopy "file1.txt,file2.txt"
  30.   --dirstocopy "dir1,dir2,dir3"
  31.   sf commerce:files:copy --copySourcePath "~/myexamplefilesdirectory" --filestocopy "file1.txt,file2.txt" --dirstocopy
  32.   "dir1,dir2,dir3"

See code: src/commands/commerce/files/copy.ts

sf commerce:ordermanagement:quickstart:setup [-y] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Set up order management

  1. USAGE
  2.   $ sf commerce:ordermanagement:quickstart:setup [-y] [-u <string>] [--apiversion <string>] [--json] [--loglevel
  3.   trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
  5. OPTIONS
  6.   -u, --targetusername=targetusername                                               username or alias for the target
  7.                                                                                     org; overrides default target org
  9.   -y, --prompt                                                                      If there is a file difference
  10.                                                                                     detected, prompt before overwriting
  11.                                                                                     file
  13.   --apiversion=apiversion                                                           override the api version used for
  14.                                                                                     api requests made by this command
  16.   --json                                                                            format output as json
  18.   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
  19.                                                                                     this command invocation
  21. EXAMPLE
  22.   sf commerce:ordermanagement:quickstart:setup

See code: src/commands/commerce/ordermanagement/quickstart/setup.ts

sf commerce:payments:quickstart:setup -n <string> [-p <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Set up a new Payment Gateway

  1. USAGE
  2.   $ sf commerce:payments:quickstart:setup -n <string> [-p <string>] [-u <string>] [--apiversion <string>] [--json]
  3.   [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
  5. OPTIONS
  6.   -n, --store-name=store-name                                                       (required) [default: 1commerce] name
  7.                                                                                     of the site to create
  9.   -p, --payment-adapter=payment-adapter                                             [default: Stripe] Payment Adapter
  11.   -u, --targetusername=targetusername                                               username or alias for the target
  12.                                                                                     org; overrides default target org
  14.   --apiversion=apiversion                                                           override the api version used for
  15.                                                                                     api requests made by this command
  17.   --json                                                                            format output as json
  19.   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
  20.                                                                                     this command invocation
  22. EXAMPLE
  23.   sf commerce:payments:quickstart:setup -p Stripe -n 1commerce

See code: src/commands/commerce/payments/quickstart/setup.ts

sf commerce:products:import -n <string> [-c <string>] [-f <filepath>] [-o <string>] [-y] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Prepare product data files for import

  1. USAGE
  2.   $ sf commerce:products:import -n <string> [-c <string>] [-f <filepath>] [-o <string>] [-y] [-v <string>] [-u
  3.   <string>] [--apiversion <string>] [--json] [--loglevel
  4.   trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
  6. OPTIONS
  7.   -c, --products-file-csv=products-file-csv                                         [default: ~/.commerc
  8.                                                                                     e/examples/csv/Alpine-small.csv] The
  9.                                                                                     csv file containing products to
  10.                                                                                     import.  Pass in empty value to do
  11.                                                                                     product-less import
  13.   -f, --definitionfile=definitionfile                                               [default: ~/.commerc
  14.                                                                                     e/config/store-scratch-def.json]
  15.                                                                                     config file
  17.   -n, --store-name=store-name                                                       (required) [default: 1commerce] name
  18.                                                                                     of the site to create
  20.   -o, --type=b2c|b2b                                                                [default: b2c] The type of store you
  21.                                                                                     want to create
  23.   -u, --targetusername=targetusername                                               username or alias for the target
  24.                                                                                     org; overrides default target org
  26.   -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
  27.                                                                                     org; overrides default dev hub org
  29.   -y, --prompt                                                                      If there is a file difference
  30.                                                                                     detected, prompt before overwriting
  31.                                                                                     file
  33.   --apiversion=apiversion                                                           override the api version used for
  34.                                                                                     api requests made by this command
  36.   --json                                                                            format output as json
  38.   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
  39.                                                                                     this command invocation
  41. EXAMPLE
  42.   sf commerce:products:import --store-name test-store

See code: src/commands/commerce/products/import.ts

sf commerce:scratchorg:create [-u <string>] [-a <string>] [-t <string>] [-w <number>] [-y] [-d <number>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Create a scratch org

  1. USAGE
  2.   $ sf commerce:scratchorg:create [-u <string>] [-a <string>] [-t <string>] [-w <number>] [-y] [-d <number>] [-v
  3.   <string>] [--apiversion <string>] [--json] [--loglevel
  4.   trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
  6. OPTIONS
  7.   -a, --alias=alias                                                                 Alias name for this scratch org
  9.   -d, --duration=duration                                                           [default: 30] Duration of the
  10.                                                                                     scratch org (in days)
  12.   -t, --type=type                                                                   [default: both] b2b, b2c or both
  14.   -u, --username=username                                                           username of the admin to associate
  15.                                                                                     with the scratch org.
  17.   -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
  18.                                                                                     org; overrides default dev hub org
  20.   -w, --wait=wait                                                                   [default: 15] The streaming client
  21.                                                                                     socket timeout (in minutes)
  23.   -y, --prompt                                                                      If there is a file difference
  24.                                                                                     detected, prompt before overwriting
  25.                                                                                     file
  27.   --apiversion=apiversion                                                           override the api version used for
  28.                                                                                     api requests made by this command
  30.   --json                                                                            format output as json
  32.   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
  33.                                                                                     this command invocation
  35. EXAMPLE
  36.   sf commerce:scratchorg:create --username demo@1commerce.com --targetdevhubusername ceo@mydevhub.com

See code: src/commands/commerce/scratchorg/create.ts

sf commerce:search:start [-n <string> | -i <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Start search indexing for a given webstore

  1. USAGE
  2.   $ sf commerce:search:start [-n <string> | -i <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
  3.   trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
  5. OPTIONS
  6.   -i, --store-id=store-id                                                           ID of webstore to index
  7.   -n, --store-name=store-name                                                       name of webstore to index
  9.   -u, --targetusername=targetusername                                               username or alias for the target
  10.                                                                                     org; overrides default target org
  12.   --apiversion=apiversion                                                           override the api version used for
  13.                                                                                     api requests made by this command
  15.   --json                                                                            format output as json
  17.   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
  18.                                                                                     this command invocation
  20. EXAMPLE
  21.   sf commerce:store:search:start -n storeName
  22.           // Finds a store and indexes it

See code: src/commands/commerce/search/start.ts

sf commerce:store:create [name=value...] -n <string> [-t <string>] [-f <filepath>] [-o <string>] [-b <string>] [-y] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Comprehensive create and set up a store. This will create your community/store push store sources, create buyer user, import products, create search index.

  1. USAGE
  2.   $ sf commerce:store:create [name=value...] -n <string> [-t <string>] [-f <filepath>] [-o <string>] [-b <string>]
  3.   [-y] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
  4.   trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
  6. OPTIONS
  7.   -b, --buyer-username=buyer-username
  8.       [default: buyer@1commerce.com] buyer's username
  10.   -f, --definitionfile=definitionfile
  11.       The store config file. By default it will be either of ~/.commerce/config/b2c-store-scratch-def or
  12.       ~/.commerce/config/b2b-store-scratch-def based on store type. Default store type is b2c.]
  14.   -n, --store-name=store-name
  15.       (required) [default: 1commerce] name of the site to create
  17.   -o, --type=b2c|b2b
  18.       [default: b2c] The type of store you want to create
  20.   -t, --templatename=templatename
  21.       Template to use to create a site. If not specified, the template is retrieved from the store config file based on
  22.       the store type (b2b or b2c).
  24.   -u, --targetusername=targetusername
  25.       username or alias for the target org; overrides default target org
  27.   -v, --targetdevhubusername=targetdevhubusername
  28.       username or alias for the dev hub org; overrides default dev hub org
  30.   -y, --prompt
  31.       If there is a file difference detected, prompt before overwriting file
  33.   --apiversion=apiversion
  34.       override the api version used for api requests made by this command
  36.   --json
  37.       format output as json
  39.   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)
  40.       [default: warn] logging level for this command invocation
  42. EXAMPLE
  43.   sf commerce:store:create --store-name test-store

See code: src/commands/commerce/store/create.ts

sf commerce:store:display -n <string> [-b <string>] [-p <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Display buyer info

  1. USAGE
  2.   $ sf commerce:store:display -n <string> [-b <string>] [-p <string>] [-v <string>] [-u <string>] [--apiversion
  3.   <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
  5. OPTIONS
  6.   -b, --buyer-username=buyer-username                                               [default: buyer@1commerce.com]
  7.                                                                                     buyer's username
  9.   -n, --store-name=store-name                                                       (required) [default: 1commerce] name
  10.                                                                                     of the site to create
  12.   -p, --urlpathprefix=urlpathprefix                                                 required if different from
  13.                                                                                     store-name URL to append to the
  14.                                                                                     domain created when Experiences was
  15.                                                                                     enabled for this org
  17.   -u, --targetusername=targetusername                                               username or alias for the target
  18.                                                                                     org; overrides default target org
  20.   -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
  21.                                                                                     org; overrides default dev hub org
  23.   --apiversion=apiversion                                                           override the api version used for
  24.                                                                                     api requests made by this command
  26.   --json                                                                            format output as json
  28.   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
  29.                                                                                     this command invocation
  31. EXAMPLE
  32.   sf commerce:store:display --store-name test-store

See code: src/commands/commerce/store/display.ts

sf commerce:store:open -n <string> [--all] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Open store(s)

  1. USAGE
  2.   $ sf commerce:store:open -n <string> [--all] [-v <string>] [-u <string>] [--apiversion <string>] [--json]
  3.   [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
  5. OPTIONS
  6.   -n, --store-name=store-name                                                       (required) [default: 1commerce] name
  7.                                                                                     of the site to create
  9.   -u, --targetusername=targetusername                                               username or alias for the target
  10.                                                                                     org; overrides default target org
  12.   -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
  13.                                                                                     org; overrides default dev hub org
  15.   --all                                                                             View All stores using sf org open
  16.                                                                                     _ui/networks/setup/SetupNetworksPage
  17.                                                                                     page
  19.   --apiversion=apiversion                                                           override the api version used for
  20.                                                                                     api requests made by this command
  22.   --json                                                                            format output as json
  24.   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
  25.                                                                                     this command invocation
  27. EXAMPLES
  28.   sf commerce:store:open --store-name test-store
  29.   sf commerce:store:open --all

See code: src/commands/commerce/store/open.ts

sf commerce:store:quickstart:create [name=value...] -n <string> [-t <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Use this command to just create a community. It will use sf community create until a community is created or failed.

  1. USAGE
  2.   $ sf commerce:store:quickstart:create [name=value...] -n <string> [-t <string>] [-u <string>] [--apiversion
  3.   <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
  5. OPTIONS
  6.   -n, --store-name=store-name
  7.       (required) [default: 1commerce] name of the site to create
  9.   -t, --templatename=templatename
  10.       [default: b2c-lite-storefront] Template to use to create a site. If not specified, the template is retrieved from
  11.       the store config file based on the store type (b2b or b2c).
  13.   -u, --targetusername=targetusername
  14.       username or alias for the target org; overrides default target org
  16.   --apiversion=apiversion
  17.       override the api version used for api requests made by this command
  19.   --json
  20.       format output as json
  22.   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)
  23.       [default: warn] logging level for this command invocation
  25. EXAMPLE
  26.   sf commerce:store:quickstart:create --templatename 'b2c-lite-storefront'

See code: src/commands/commerce/store/quickstart/create.ts

sf commerce:store:quickstart:setup [name=value...] -n <string> [-f <filepath>] [-y] [-t <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Set up a store

  1. USAGE
  2.   $ sf commerce:store:quickstart:setup [name=value...] -n <string> [-f <filepath>] [-y] [-t <string>] [-v <string>]
  3.   [-u <string>] [--apiversion <string>] [--json] [--loglevel
  4.   trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
  6. OPTIONS
  7.   -f, --definitionfile=definitionfile
  8.       [default: ~/.commerce/config/store-scratch-def.json] config file
  10.   -n, --store-name=store-name
  11.       (required) [default: 1commerce] name of the site to create
  13.   -t, --templatename=templatename
  14.       [default: b2c-lite-storefront] Template to use to create a site. If not specified, the template is retrieved from
  15.       the store config file based on the store type (b2b or b2c).
  17.   -u, --targetusername=targetusername
  18.       username or alias for the target org; overrides default target org
  20.   -v, --targetdevhubusername=targetdevhubusername
  21.       username or alias for the dev hub org; overrides default dev hub org
  23.   -y, --prompt
  24.       If there is a file difference detected, prompt before overwriting file
  26.   --apiversion=apiversion
  27.       override the api version used for api requests made by this command
  29.   --json
  30.       format output as json
  32.   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)
  33.       [default: warn] logging level for this command invocation
  35. EXAMPLE
  36.   sf commerce:store:quickstart:setup --definitionfile store-scratch-def.json

See code: src/commands/commerce/store/quickstart/setup.ts

Debugging your plugin

Please see our CONTRIBUTING guide.