Theme commands

This reference lists the theme commands that you can use with Shoplazza CLI. The commands in this group use the syntax shoplazza theme [command].

To access help for any of these commands from the command line, use shoplazza [command] -h.

init

Clones a Git repository to your local machine to use as the starting point for building a theme.

If no Git repository is specified, then this command creates a copy of Lifestyle, Shoplazza's example theme, with the specified name in the current folder. If no name is provided, then you're prompted to enter one.

shoplazza theme init [ options ]

🚧

Caution

If you're building a theme for the Shoplazza Theme Store, then you can use Lifestyle as a starting point. However, the theme that you submit needs to be substantively different from Lifestyle so that it provides added value for merchants. Learn about the ways that you can use Lifestyle.

serve

Uploads the current theme as a development theme to the store that you're connected to, and returns the following information:

• A link to your development theme at http://your-store.myshoplaza.com/?preview_theme_id={preview-theme-id}. This URL allow you to preview changes using the store's data.

• A link to the editor for the theme in the Store admin.

• A preview link that you can share with others.

You can only run this command in a directory that matches the default Shoplazza theme folder structure.

shoplazza theme serve

list

Lists the themes in your store, along with their IDs and statuses.

shoplazza theme list

pull

Retrieves theme files from Shoplazza.

If no theme is specified, then you're prompted to select the theme to pull from the list of the themes in your store.

shoplazza theme pull [ options ]

Optional parameters

push

Uploads your local theme files to Shoplazza, overwriting the remote theme if specified.

If no theme is specified, then you're prompted to select the theme to overwrite from the list of the themes in your store.

You can only run this command in a directory that matches the default Shoplazza theme folder structure.

shoplazza theme push [ options ]

Optional parameters

publish

Publishes an unpublished theme from your theme library.

If no theme ID is specified, then you're prompted to select the theme that you want to publish from the list of themes in your store.

You can only run this command in a directory that matches the default Shoplazza theme folder structure.

If you want to publish your local theme, then you need to run shoplazza theme push first. You're asked to confirm that you want to publish the specified theme.

shoplazza theme publish [ THEME_ID ]

Optional parameters

package

Packages your local theme files into a ZIP file that can be uploaded to Shoplazza.

Only folders that match the default Shoplazza theme folder structure are included in the package.

The ZIP file uses the name theme_name-theme_version.zip, based on parameters in your settings_schema.json file.

shoplazza theme package

delete

Deletes a theme from your store.

You can specify multiple themes by ID. If no theme is specified, then you're prompted to select the theme that you want to delete from the list of themes in your store.

You're asked to confirm that you want to delete the specified themes before they are deleted.

shoplazza theme delete { THEME_ID ]