Skip to main content

Quick start

Get up and running with Shoplazza CLI in 3 minutes.

Step 1: Install​

npm install -g shoplazza-cli

For other installation methods, see Install Shoplazza CLI.

Step 2: Authenticate​

Log in with your Shoplazza partner account and connect to a store:

shoplazza auth login --store-domain my-store.myshoplaza.com --domain products,orders

This opens your browser for OAuth authorization. After granting access, the CLI stores your credentials securely in your OS keychain.

To verify your authentication status:

shoplazza auth status

Step 3: Run your first command​

Search for products in your store:

shoplazza products +search --keyword "shirt"

List orders in table format:

shoplazza orders +search --format table

Check available API commands with schema introspection:

shoplazza schema products

What's next​

For app developers​

Initialize a new app project:

shoplazza app init --name "my-app"

Then follow the App command best practice tutorial.

For theme developers​

Scaffold a new theme based on Nova 2023:

shoplazza themes init

Then preview it locally:

shoplazza themes serve

See the Theme CLI guide for more details.

Explore commands​