Skip to main content

theme-extension

Build, test, and deploy theme extensions. Alias: te.

create

Scaffold a new theme extension.

shoplazza theme-extension create [flags]

Flags

FlagTypeDescription
--name <name>stringProject name / target directory (required)
--type <type>stringTemplate type: basic or embed (required)

serve

Register, push, and start incremental sync with file watching.

shoplazza theme-extension serve [flags]

Flags

FlagTypeDescription
--theme-id, -t <THEME_ID>stringTheme ID (required)
--project-root <path>stringProject root directory

build

Build a new theme-extension version (zip, upload, and create the version on the server).

shoplazza theme-extension build [flags]

Flags

FlagTypeDescription
--version <version>stringNew semver version, e.g. 1.0.0 (required)
--description <text>stringVersion description (required)
--store-domain, -s <domain>stringTarget store (defaults to current store)
--path <path>stringProject path (default: current directory)

deploy

Enable a version in the current store.

shoplazza theme-extension deploy [flags]

Flags

FlagTypeDescription
--version <version>stringVersion to enable, e.g. 1.0.0 (defaults to the version recorded by te build)
--path <path>stringProject path (default: current directory)
--debugboolPrint the raw publish request/response for troubleshooting

connect

Link this theme extension to an app.

shoplazza theme-extension connect [flags]

Flags

FlagTypeDescription
--client-id <id>stringApp client_id to link (required)
--partner <id>stringPartner id (auto-selected if you have only one)
--path <path>stringProject path (default: current directory)

release

Publish a version in the bound app.

shoplazza theme-extension release [flags]

Flags

FlagTypeDescription
--version <version>stringVersion to publish, e.g. 1.0.0 (defaults to the version recorded by te build)
--path <path>stringProject path (default: current directory)
--debugboolPrint the resolved publish request for troubleshooting

list

List the store's theme extensions.

shoplazza theme-extension list [flags]

Flags

FlagTypeDescription
--store-domain, -s <domain>stringTarget store (defaults to current store)

versions

List a theme extension's versions.

shoplazza theme-extension versions [flags]

Flags

FlagTypeDescription
--path <path>stringProject path (default: current directory)