Do You Have to Use Stencil Cli to Upload a Theme

Stencil CLI

npm (scoped)

The BigCommerce server emulator for local theme development.

Install

Note: Stencil requires the Node.js runtime surround, version 12.x and 14.ten (Recommended) are supported. We do non yet have back up for versions greater than Node 14.

Run npm install -g @bigcommerce/stencil-cli.

Visit the installation guide for more details.

Usage

              Usage: stencil [options] [command]  Commands:    init        Interactively create a .stencil file which configures how to run a BigCommerce shop locally.   offset       Starts up the BigCommerce storefront local development environment, using theme files in the electric current directory and data from the live shop.   parcel      Bundles upwards the theme into a zip file which can exist uploaded to BigCommerce.   release     Create a new release in the theme'south github repository.   button        Bundles up the theme into a zero file and uploads it to your store.   pull        Pulls the configuration from the active theme on your live shop and updates your local configuration.   download    Downloads the theme files from the active theme on your live store.   aid [cmd]  display help for [cmd]  Options:    -h, --help     output usage information   -Five, --version  output the version number

Run stencil init at the meridian level of your Stencil Theme. It will ask you a few questions to get your started.

Run stencil beginning to run a local server so you can start developing your theme.

Run with -o or --open to automatically open up a browser.

While stencil is running, you tin blazon "rs" and then hit enter to auto-reload all browsers. This is like to Nodemon's rs choice.

Run stencil parcel to validate your code and create a null bundle file that can be uploaded to BigCommerce.

Run stencil release to tag a new version of your theme, create a GitHub release in your theme repository, and upload the zip bundle file to the release avails. This is useful for tracking your changes in your Theme, and is the tool nosotros use to create new releases in BigCommerce Cornerstone theme.

Run stencil button to parcel the local theme and upload it to your store, then it will exist available in My Themes. To button the theme and also actuate information technology, use stencil push -a. To automatically delete the oldest theme if you are at your theme limit, use stencil push -d. These can be used together, equally stencil push -a -d. You can apply the theme to multiple storefronts, just specify ids of desired storefronts/channels after -c choice stencil button -a -c 123 456 789. If you want to apply theme to all available storefronts, but use -allc option: stencil push button -a -allc.

Run stencil pull to sync changes to your theme configuration from your live shop. For example, if Page Builder has been used to change certain theme settings, this will update those settings in config.json in your theme files so you lot don't overwrite them on your next upload.

Features

BrowserSync

Stencil CLI comes packaged with BrowserSync so you can accept advantage of all of those astonishing goodies! Have a look at their spider web site for more than information.

Sass compiling

You lot tin compile Sass (node-sass) scss files in assets/scss into CSS. For example, add an scss file named theme.scss to assets/scss and {{{stylesheet 'avails/css/theme.css'}}} to your theme HTML template. Stencil-CLI will compile avails/scss/theme.scss to CSS on the fly.

Autoprefixer

Stencil CLI comes packaged with Autoprefixer. You tin set which browsers should exist targeted, as well as if it should cascade the generated rules in the theme's config.json file with these options:

autoprefixer_cascade - Defaults to true.
autoprefixer_browsers - Defaults to ["> 1%", "final 2 versions", "Firefox ESR"].

How to become assistance or written report a bug

If you need any assist or experience any bugs, delight create a GitHub issue in this repository.

Development

If yous would similar to ameliorate this projection check out the Contributing Guide. Also, you can discover the implementation details in that location.

License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the post-obit weather condition are met:

Redistributions of source code must retain the above copyright notice, this listing of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
All advert materials mentioning features or use of this software must display the following acknowledgement: This product includes software developed by BigCommerce Inc.
Neither the proper noun of BigCommerce Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED Past BIGCOMMERCE INC ''Equally IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT Not LIMITED TO, THE Implied WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A Particular PURPOSE ARE DISCLAIMED. IN NO Result SHALL BIGCOMMERCE INC BE LIABLE FOR Whatsoever Straight, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL Damages (INCLUDING, BUT Non LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF Utilize, DATA, OR PROFITS; OR BUSINESS Pause) Withal CAUSED AND ON Whatever THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN Whatever Way OUT OF THE Apply OF THIS SOFTWARE, Fifty-fifty IF Advised OF THE POSSIBILITY OF SUCH Impairment.