Skip to main content

Install Shoplazza CLI

This guide shows you how to install Shoplazza CLI on macOS, Windows, or Linux.

Requirements​

RequirementVersion
Node.js16.0.0 or higher
GitLatest recommended
tip

Node.js is required for the checkout extension toolchain (Vite) and for shoplazza update, which updates through npm. If you only use the CLI for API commands and shortcuts, the standalone binary works without Node.js.

shell
npm install -g shoplazza-cli

Install via shell script (macOS / Linux)​

For environments without Node.js, you can install the standalone Go binary:

shell
curl -fsSL https://raw.githubusercontent.com/shoplazza/shoplazza-cli/main/install.sh | bash

The script automatically detects your OS and architecture, downloads the appropriate binary, and places it in /usr/local/bin (set INSTALL_DIR to use another directory).

To install a specific version, set VERSION (without the leading v):

shell
curl -fsSL https://raw.githubusercontent.com/shoplazza/shoplazza-cli/main/install.sh | VERSION=2.0.0 bash

Install via Homebrew (macOS / Linux)​

shell
brew install Shoplazza/tap/shoplazza-cli

Install from GitHub Releases​

Download the pre-built binary for your platform from the GitHub Releases page.

PlatformArchitectureFile
macOSIntel (x86_64)shoplazza-cli-<version>-darwin-amd64.tar.gz
macOSApple Silicon (arm64)shoplazza-cli-<version>-darwin-arm64.tar.gz
Linuxx86_64shoplazza-cli-<version>-linux-amd64.tar.gz
Linuxarm64shoplazza-cli-<version>-linux-arm64.tar.gz
Windowsx86_64shoplazza-cli-<version>-windows-amd64.zip
Windowsarm64shoplazza-cli-<version>-windows-arm64.zip

After downloading, extract the binary and move it to a directory in your PATH:

shell
tar -xzf shoplazza-cli-2.2.2-darwin-arm64.tar.gz
sudo mv shoplazza /usr/local/bin/

Verify the installation​

shell
shoplazza --version

The command prints the version number and build date, followed by whether the Agent Skills are installed.

Shell completion​

Shoplazza CLI supports shell completion for bash, zsh, fish, and PowerShell:

shell
# Bash
shoplazza completion bash > /etc/bash_completion.d/shoplazza

# Zsh
shoplazza completion zsh > "${fpath[1]}/_shoplazza"

# Fish
shoplazza completion fish > ~/.config/fish/completions/shoplazza.fish

# PowerShell
shoplazza completion powershell > shoplazza.ps1

Upgrade​

shell
# npm (also refreshes the API metadata and installed Agent Skills)
shoplazza update
# or
npm update -g shoplazza-cli

# Homebrew
brew upgrade shoplazza-cli

# shell script (re-run installer)
curl -fsSL https://raw.githubusercontent.com/shoplazza/shoplazza-cli/main/install.sh | bash

Next steps​