Overview

Shoplazza CLI is a command-line interface tool that helps you build Shoplazza apps and themes. It quickly generates apps, and Shoplazza themes. You can also use it to automate many common development tasks.

This documentation explains how to use Shoplazza CLI for theme development.

Features

Shoplazza CLI accelerates your theme development process with the following features:

• Safely preview, test, and share changes to themes using development themes

• Hot reload CSS and section changes, or automatically refresh a page on file change, when previewing a theme.

• Initialize a new theme using Lifestyle as a starting point

• Push and publish themes from the command line

• Use workflow tools like Git to work with a team of theme developers.

• Upload themes to your store.

• Watch for local changes and upload them automatically to Shoplazza.

• Work on Linux, macOS, and Windows.

Development themes

Development themes are themes that are connected to the Shoplazza store that you're using for development. When you connect your theme to a store as a development theme, you can use that store's data for testing.

You can create a development theme using the shoplazza theme serve command.

Your development theme can be used to perform the following tasks:

• View changes in real time to a theme that you're developing locally

• Customize and interact with the theme using the Store admin theme editor

• Share a password-protected preview of the theme with other developers

Installation

To learn how to install Shoplazza CLI on Windows, macOS, or Linux, refer to Install Shoplazza CLI.

Getting started

Review the getting started with Shoplazza CLI guide to learn about topics including:

• Requirements for using Shoplazza CLI

• Connecting to a store

• Creating a new theme

• Previewing a theme

• Checking a theme for errors

Directory structure

You can run certain theme commands, such as shoplazza theme serve, only if the directory you're using matches the default Shoplazza theme directory structure. If you use build tools to generate theme files, then you might need to run commands from the directory where the generated files are stored.

The default Shoplazza theme directory structure is as follows:

└── project
    ├── assets
    ├── config
    ├── layout
    ├── locales
    ├── sections
    ├── snippets
    └── templates
        └── customers

Command references

Shoplazza CLI offers basic commands for authenticating and communicating with Shoplazza, and specific commands for theme development.

Upgrade or uninstall Shoplazza CLI

To learn how to upgrade Shoplazza CLI, migrate from a legacy version, and uninstall Shoplazza CLI, refer to Upgrade or uninstall Shoplazza CLI.