Sprokit CLI

This is a command line interface for Sprokit. It's meant to work in combination with the Sprokit app for BigCommerce.

Installation

npm install -g sprokit@latest

Usage

Deploy BigCommerce Custom Checkout

To manage multiple versions of custom checkout in Sprokit, you can deploy your custom checkout codebase using the deploy command.

Note: This command is only available for BigCommerce Checkout JS (https://github.com/bigcommerce/checkout-js)

sprokit deploy

The deploy command will do the following:

1. Build custom checkout.
2. Create a versioned folder in WebDAV.
3. Upload custom checkout files to the versioned folder.
4. Provide instructions for updating the custom checkout script in the BigCommerce control panel.

The First Run

During the first run of sprokit deploy, you will be prompted to enter your BigCommerce store hash, WebDAV username, and WebDAV password. These credentials will be saved in a .sprokitrc file in your project directory and added to your .gitignore file. Please do not commit this file to your repository.

---------------------------------------
Sprokit - Custom Checkout Deployment
---------------------------------------
? Enter BigCommerce Store Hash:
? Enter BigCommerce WebDAV Username:
? Enter BigCommerce WebDAV Password:
? Enter BigCommerce API Access Token (optional):
? Would you like to save these credentials for future use? (Y/n):

The next time you run the deploy command, you will not be prompted for these credentials.

Credentials

Your BigCommerce WebDAV credentials are only used to deploy custom checkout files to your BigCommerce store. The .sprokitrc file is saved in your project directory and is not shared with anyone. You can delete this file at any time, although you will be prompted to re-enter your credentials the next time you run the deploy command.

API Access Token (optional)

If you have an API access token for your BigCommerce store, you can enter it when prompted. This will allow the deploy command to update the checkout settings through the API.

If you do not have an API access token or choose to not use this feature, the deploy command will show you the manual instructions for updating the checkout settings in the BigCommerce control panel.