Skip to main content

App command reference

This reference lists the Shoplazza CLI commands for app development. For theme commands, refer to the Theme command reference.

The commands in this group use the syntax shoplazza [topic] [command].

Command overview​

Topic Command Description
none login Authenticates and logs you into the specified store with Shoplazza CLI.
logout Logs you out of your Shoplazza account.
switch Switches between stores without logging out and logging in again.
store Displays the store that you're currently connected to.
version Displays the version of Shoplazza CLI that you're running.
help Lists the available commands and describes what they do.
app init Initialize a new application project. Create a new application project, or connect an existing application project.
generate extension Generate an extension template. Add new extensions to an existing application.
dev Start a local development server. Local development and debugging.
deploy Deploy the application to the production environment. Publish the application to production.
app config link Link an application configuration file. Connect an existing application to a local project.
config use Switch between application configuration files. Switch between multiple application configurations.
versions list View the list of application versions. Manage application version history.

App Commands Details​

app Init​

Create a new application project, or connect an exist application project.

shoplazza app init

Init flags​

Flag Description
--path <path> Specify the project creation path (Default: Current directory)
--client-id <client-id> Specify the client ID of the existing application to connect to
--name <name> Specify the application name

generate extension​

Generate a new extension template for an existing application, supporting various types of extensions.

shoplazza app generate extension

generate extension flags​

Flag Description
--path <path> Specify the project path (Default: Current directory)

dev​

Start a local development server.

shoplazza app dev

dev flags​

Flag Description
--path <path> Specify the project path (Default: Current directory)

deploy​

Deploy the application to the production environment.

shoplazza app deploy

deploy flags​

Flag Description
--path <path> Specify the project path (Default: Current directory)

Link an existing Shoplazza application to a local project, creating a configuration file.

shoplazza app config link
Flag Description
--path <path> Specify the project path (Default: Current directory)
--client-id <client-id> Specify the client ID of the application to link

config use​

Switch between multiple application configuration files within a project, activating the specified configuration.

shoplazza app config use

config use flags​

Flag Description
--path <path> Specify the project path (Default: Current directory)

versions list​

View all deployed versions of the application, supporting pagination and detailed information display.

shoplazza app versions list

versions list flags​

Flag Description
--path <path> Specify the project path (Default: Current directory)
--page-size <number> Number of versions to display per page (Default: 10)

No-Prefix Commands Details​

login​

Logs you in the Shoplazza account.

shoplazza login

login flags​

Flag Description
--store <store>
The development store that you want to use to preview your theme.
The --store flag accepts the following inputs:
  • The store prefix, e.g. my-store.myshoplaza.com
  • The Shoplazza URL, e.g. https://my-store.myshoplaza.com

logout​

Logs you out of the Shoplazza account.

shoplazza logout

switch​

Switches between stores without logging out and logging in again.

If you enter this command without a --store flag, then you're prompted to select a store associated with your account.

shoplazza switch

switch flags​

Flag Description
--store <store>
The development store that you want to use to switch your theme.
The --store flag accepts the following inputs:
  • The store prefix, e.g. my-store.myshoplaza.com
  • The Shoplazza URL, e.g. https://my-store.myshoplaza.com

store​

Displays the store that you're currently connected to.

shoplazza store

version​

Displays the version of Shoplazza CLI that you're running.

shoplazza version

help​

Lists the available commands and describes what they do.

shoplazza help

TerminalYou can also use the help command or options to get more detailed information about a specific command:

shoplazza help [command]

OR,

shoplazza [command] --help

OR,

shoplazza [command] -h