# Command reference

> Index of every Shoplazza CLI command grouped by topic — authentication, apps, themes, extensions, store data, platform features, utilities — plus global flags.

This reference lists all Shoplazza CLI commands organized by topic.

## Command syntax

```
shoplazza [topic] [command] [flags]
```

## Three-layer command system

Shoplazza CLI provides three layers of commands for progressive depth of control:

| Layer | Syntax | When to use |
|-------|--------|-------------|
| **Shortcuts** | `shoplazza <topic> +<action>` | Day-to-day operations with smart defaults |
| **API commands** | `shoplazza <topic> <action>` | Full control over API parameters |
| **Raw API** | `shoplazza api rest <METHOD> <PATH>` | Any endpoint not covered above |

For details, see [Three-layer command system](../guides/command-layers).

## Command groups

### Authentication & configuration

| Command | Description |
|---------|-------------|
| [auth login](./auth#login) | Log in via OAuth 2.0 |
| [auth logout](./auth#logout) | Remove stored credentials |
| [auth status](./auth#status) | Show current authentication state |
| [auth scopes](./auth#scopes) | List available OAuth scopes |
| [auth store use](./auth#store-use) | Switch to a different store |

### App development

| Command | Description |
|---------|-------------|
| [app init](./app#init) | Initialize or link an app project |
| [app list](./app#list) | List apps in your account |
| [app info](./app#info) | Show app metadata |
| [app dev](./app#dev) | Start local development server |
| [app deploy](./app#deploy) | Deploy app to production |
| [app config link](./app#config-link) | Link app configuration |
| [app config use](./app#config-use) | Switch app configuration |
| [app extension create](./app#extension-create) | Scaffold a new extension |
| [app versions](./app#versions) | List deployed versions |
| [app function compile](./app#function-compile) | Compile function extension to WASM |
| [app function release](./app#function-release) | Compile and publish function extension |
| [app function list](./app#function-list) | List function extensions |

### Theme development

| Command | Description |
|---------|-------------|
| [themes init](./theme#init) | Scaffold a new theme |
| [themes serve](./theme#serve) | Preview theme with live reload |
| [themes pull](./theme#pull) | Download theme from store |
| [themes push](./theme#push) | Upload theme to store |
| [themes package](./theme#package) | Package theme as ZIP |
| [themes share](./theme#share) | Share theme preview link |

### Extensions

| Command | Description |
|---------|-------------|
| [checkout-extension init](./checkout-extension#init) | Scaffold checkout extension project |
| [checkout-extension create](./checkout-extension#create) | Add extension to existing project |
| [checkout-extension dev](./checkout-extension#dev) | Local dev server on :8888 |
| [checkout-extension build](./checkout-extension#build) | Build extension with Vite |
| [checkout-extension push](./checkout-extension#push) | Upload new version |
| [checkout-extension deploy](./checkout-extension#deploy) | Activate a version |
| [checkout-extension undeploy](./checkout-extension#undeploy) | Deactivate an extension |
| [theme-extension create](./theme-extension#create) | Scaffold theme extension |
| [theme-extension serve](./theme-extension#serve) | Dev server with live sync |
| [theme-extension build](./theme-extension#build) | Build a new version |
| [theme-extension deploy](./theme-extension#deploy) | Enable a version in store |
| [theme-extension connect](./theme-extension#connect) | Link extension to an app |
| [theme-extension release](./theme-extension#release) | Publish version in bound app |

### Store data (shortcuts + API commands)

| Topic | Shortcuts | API commands | Reference |
|-------|-----------|--------------|-----------|
| Products | `+search`, `+create`, `+set-price`, `+stock`, `+publish`, `+unpublish`, `+count`, `collections +create` | 78 | [products](./products) |
| Orders | `+search`, `+count`, `+ship`, `+refund`, `+update-tracking` | 36 | [orders](./orders) |
| Discounts | `+search`, `+rebate`, `+flashsale`, `+mn-discount`, `+percent-code`, `+amount-code`, `+bxgy-code`, `+free-shipping-code` | 15 | [discounts](./discounts) |
| Customers | `+search`, `+create` | 11 | [customers](./customers) |
| Shop | `+upload-file` | 64 | [shop](./shop) |
| Themes (API) | — | 15 | [themes-api](./themes-api) |

### Platform features

| Command | Description |
|---------|-------------|
| [billing one-time](./billing#one-time) | One-time charge management |
| [billing recurring](./billing#recurring) | Recurring subscription management |
| [billing usage](./billing#usage) | Usage-based billing |
| [billing transactions](./billing#transactions) | Transaction queries |
| [webhook create](./webhook#create) | Register event webhooks |
| [webhook list](./webhook#list) | List registered webhooks |

### Utilities

| Command | Description |
|---------|-------------|
| [api rest](./api#rest) | Raw HTTP requests to any endpoint |
| [schema](./schema) | Inspect available APIs and parameters |
| [update](./update) | Update CLI to latest version |
| [completion](./completion) | Generate shell completion scripts |
| [doctor](./doctor) | Run diagnostic checks |
| `--version` / `-v` | Display CLI version |
| `--help` / `-h` | Show command help |

## Global flags

These flags are available on all commands:

| Flag | Description |
|------|-------------|
| `--format <json\|pretty\|table>` | Output format (default: `json`) |
| `--jq <expression>` / `-q` | Filter JSON output with jq expression |
| `--dry-run` | Preview the request without executing |
| `--debug` | Enable debug output |
| `--version` / `-v` | Display CLI version |
| `--help` / `-h` | Show command help |

For details, see [Global flags](../reference/global-flags).