#Bigcommerce install stencil cli full#

As you navigate through the site, Stencil CLI will use store API token supplied to make API calls to BigCommerceРІР‚в„ўs API and populate the theme preview with live store data in order to mimic production as closely as possible.Р”Р‡or a full list of Stencil CLI commands, see Stencil CLI Options and Commands. To preview the theme on multiple devices simultaneously, browse to the external URL on the desired devices. Local: # preview real-time changes on your local machineР”В®xternal: # preview real-time changes across multiple devicesР”В«rowse to the local URL to preview the theme and see changes updated in real-time. Stencil start will output several URLs: #.

# install theme modules (if you haven't already) npm install # create `.stencil` or `` configuration file (if using Stencil V3.1 release or later) stencil or configuration file (if using Stencil V3.1 release or later) and start live preview, run the following commands in a terminal: # move into the theme's directory cd ~/path/to/theme/dir Before doing so, be sure to obtain store API credentials. This configuration file is created by running stencil init and entering the information listed above. stencil configuration file or and configuration files (if using Stencil V3.1 release or later), which contains the following information:

When stencil start is executed, Stencil CLI checks for the required.

The Browsersync preview is launched by executing the stencil start command in a terminal window. When the preview is opened on multiple devices or browser windows, scroll, click, refresh and form actions are mirrored across the browser instances. Stencil CLI uses Browsersync to serve up a live preview of a theme in development. stencil or configuration file (if using Stencil V3.1 release or later) can be initialized for the theme and development can begin. Once Stencil CLI is installed and a theme is downloaded, a. This will install the npm modules required to properly leverage the Stencil event framework. Installing theme modulesР”Р‡or theme versions 1.10.0+, modules can be installed with npm: # move into the theme dir cd ~/path/to/theme/dir If you would like to allow for complete rollback, back up your entire themeРІР‚в„ўs directory. The files contain the store URL, username, access tokens, and other settings. stencil file or and files (if using Stencil V3.1 release or later). If youРІР‚в„ўre re-installing an existing theme, be sure to back up the themeРІР‚в„ўs. For instructions on doing so, see Downloading and Uploading Custom Themes (BigCommerce Knowledge Base).Р”Вistribution of Cornerstone-based themes is subject to BigCommerceРІР‚в„ўs Cornerstone license, including the mandatory incorporation of BigCommerceРІР‚в„ўs copyright statement. To develop against BigCommerceРІР‚в„ўs Cornerstone theme (which is the building block and starting point for rapidly developing themes for BigCommerce) clone the repository from GitHub: git clone Р”В¬ornerstone and other themes can also be downloaded from the BigCommerce control panel.

publish theme - can read theme related store data and push themes to the live storefront.

local development only - can read theme related store data, but can not publish.

The Stencil-CLI Access Level can then be set by selecting local development only or publish theme: To automatically create a store API account with the scopes and permissions required by Stencil CLI, select Create Stencil-CLI Token in the Create API Accounts dropdown: For detailed instructions, see Store API Accounts. To do so, you must supply the Stencil CLI with a Stencil CLI token. Stencil CLI uses various BigCommerce APIs to inject store-specific data, like carousel images and products, into the live theme preview it serves up. If you havenРІР‚в„ўt installed it yet, see Installing Stencil CLI for detailed, system-specific instructions. The steps in this article assume youРІР‚в„ўve installed Stencil CLI on your system. This article walks you through the process of downloading a theme for development, installing theme modules, and serving a live preview using Stencil CLIРІР‚в„ўs stencil start command. Once youРІР‚в„ўve installed the Stencil CLI, the next steps are downloading a theme to edit and previewing live changes using Stencil CLIРІР‚в„ўs powerful Browsersync functionality.

Bigcommerce install stencil cli