bigcmd-alpha v0.1.1
BigCLI Documentation
What is BigCLI?
BigCLI is a set of command line tools for automating BigCommerce deployment and development tasks. These tasks include:
- Syncing/Managing non-theme elements such as custom widget templates between sites
- Developing widget templates
- possibly Syncing widget instances and placements across sites
Basics
bigcli-config.json
BigCLI keeps track of project details in the bigcli-config.json file. This file can be created manually or by initializing a new project with:
bigcli project:init
or just
bigcli init
To start a new bigcli project, you will need to generate a BigCommerce V3 API key in your store admin. If you have multiple instance of your store (prodcution, staging, develop) you may wish to generate keys for each. You will be able to set up all your instances during this process. You can always add new instances later, if necessary. Initially you must set up at least one instance.
You will need the token, client id, and store hash. The process will also ask what folder you'd like to use to store any retrieved custom widgets, etc.
Instances
Add
Current
List
Widget Templates
Compile
Coming Soon. Will compile from local dev file an API call to deploy a widget to an environment of your choosing. Can be set to do so automatically on save while developing.
Delete
Deletes a widget template.
Command: bigcli widgetTemplates:delete -u {uuid} [-i {instance}]
Alias: wt:x
Options: | Flag | Description | Required | | --- | --- | --- | | -u, --uuid | Indicates the ID of the widget template to be deleted | yes | | -i, --instance | Indicates which store instance you are targeting | |
Deploy
Coming Soon.
DeployAll
Coming Soon.
List
Lists available widgets.
Command: bigcli widgetTemplates:list [-u {uuid}] [-a] [-i {instance}]
Alias: wt:l
Note: By default shows only custom widgets. Defaults to working instance.
Options: | Flag | Description | Required | | --- | --- | --- | | -u, --uuid | Indicates the ID of the widget template to be deleted | | | -i, --instance | Indicates which store instance you are targeting | | | -a, --all | Show all widgets | |
Retrieve
Downloads a widget template to your local environment.
Command: bigcli widgetTemplates:retrieve -u {uuid} [-i {instance}]
Alias: wt:r
Options: | Flag | Description | Required | | --- | --- | --- | | -u, --uuid | Indicates the ID of the widget template to be retrieved | yes | | -i, --instance | Indicates which store instance you are targeting | |
This command will download a custom widget from the instance of your choosing and save it locally in the widget-templates/ folder (or whichever folder you have configured for storing retrieved widget templates).
This will allow you to extract the actual template, storefront graphql query, etc, for modification.
RetrieveAll
Coming Soon.
Sync
Coming Soon.