BigCommerce Stencil CLI Getting Started Documentation

Read the full Stencil CLI documentation on how to install and get started.

# For ARM based macs
arch -x86_64 /bin/zsh
 
# Install Node Version Manager (nvm)
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.31.0/install.sh | bash
 
# Install Stencil CLI supported version of Node.js
nvm install 18.15.0
 
# Switch to Stencil CLI supported version of Node.js:
nvm use 18.15.0
 
# Install Stencil CLI
npm install -g @bigcommerce/stencil-cli

# install modules using npm
npm install

# create `.stencil` or `config.stencil.json` configuration file (if using Stencil V3.1 release or later)
stencil init --url https://yourstore.com/ --token 19d3ae6-dc15-4af9-bead-a2c703aa7b --port 3000
 
# serve a live preview of the theme:
stencil start