Shoplazza CLI overview

Shoplazza CLI is a command-line tool for building Shoplazza apps, themes, and extensions. It covers the full development lifecycle — from project scaffolding and local development to deployment and version management.

What's new in v2

Shoplazza CLI v2 is a ground-up rewrite that introduces a three-layer command system, OAuth 2.0 authentication, and structured output designed for both human developers and AI agents.

Three-layer command system

Layer	Prefix	Purpose	Example
Shortcuts	+	High-frequency operations with smart defaults	shoplazza products +search --keyword "shirt"
API commands	—	1:1 mapping to platform API endpoints	shoplazza products list --format table
Raw API	api rest	Escape hatch for any endpoint	shoplazza api rest GET /openapi/2026-01/products

For details, see Three-layer command system.

Key capabilities

• App lifecycle — Initialize, develop, and deploy apps with app init, app dev, app deploy
• Theme development — Scaffold, preview, push, and publish themes (themes init, serve, pull, push, package, share), with named environments in themes env
• Extensions — Build checkout extensions and theme extensions with bundled toolchains
• Store data — Manage products, orders, customers, discounts, and more via shortcuts and API commands
• Billing & Webhooks — Create subscriptions and register event hooks
• Schema introspection — Explore all available APIs with shoplazza schema
• Store profiles — Work with several stores from one login using profile and --profile
• Agent Skills — Read the AI-agent guides embedded in the CLI with shoplazza skills

Domain coverage

Domain	Shortcuts	API Commands
Products	+search, +create, +set-price, +stock, +publish, +unpublish, +count, +set-variants, +tag	79 commands
Orders	+search, +count, +ship, +refund, +update-tracking	38 commands
Discounts	+search, +rebate, +flashsale, +mn-discount, +percent-code, +amount-code, +bxgy-code, +free-shipping-code	15 commands
Customers	+search, +create, +count	11 commands
Shop	+upload-file	95 commands
Themes	+page, +edit, +card-schema, +preview, block +edit, block +get	56 commands
Billing	—	14 commands
Webhook	—	6 commands

Installation

To install Shoplazza CLI, refer to Install Shoplazza CLI.

Getting started

Quick start

Install, authenticate, and run your first command in 3 minutes.

Tutorials

Step-by-step walkthroughs: build an app, a checkout extension, or a theme.

Command reference

Refer to the command reference to explore all available commands, organized by topic.

Authentication

Shoplazza CLI v2 uses OAuth 2.0 with PKCE for secure authentication. You can authenticate interactively via browser or non-interactively with a User Access Token (UAT) for CI/CD pipelines.

For details, see Authentication.

Output formats

All commands support structured output via the global --format flag:

Format	Description
json	Structured JSON (default when output is piped, in CI, or with --no-input) — ideal for scripting and AI agents
pretty	Human-readable key-value display (default at an interactive terminal)
table	Aligned table with headers
ndjson	One JSON object per line; list results stream one record per line
csv	CSV with a header row, for spreadsheet export

You can also filter JSON output with --jq expressions and preview requests with --dry-run.

For details, see Output formats.

Upgrade

To upgrade Shoplazza CLI to the latest version (npm installs; this also refreshes the API metadata):

shell

shoplazza update

For other installation methods, see Upgrade.

To check your current version:

shell

shoplazza --version

Theme development

For theme-specific CLI usage, refer to the Theme CLI guide.