Skip to main content

Get started

The AI Toolkit runs on Shoplazza CLI, so setup is four steps: install the CLI, add the skills, authenticate, then prompt your agent.

Requirements​

  • Node.js 16.0.0 or higher
  • An AI agent that can run shell commands (e.g. Claude Code, or any agent with terminal access)

1. Install Shoplazza CLI​

shell
npm install -g shoplazza-cli

For other methods (shell script, Homebrew, prebuilt binaries) and full details, see Install Shoplazza CLI.

2. Add the Agent Skills​

shell
npx skills add Shoplazza/shoplazza-cli -g

This installs the skills into ~/.agents/skills/ and symlinks them into your agent's skill directory, globally across projects. For the domain list and how skills work, see Agent Skills.

3. Authenticate​

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

This opens your browser for OAuth authorization and stores credentials securely in your OS keychain. Verify with shoplazza auth status. For UAT/CI login and store switching, see Authentication.

tip

If an AI agent is running the login for you, it should extract the authorization URL from the command output and send it to you — the command polls until you complete OAuth in your browser.

4. Ask your agent​

Invoke a skill with its /shoplazza-<domain> prefix, then describe the task in plain language:

/shoplazza-products Show me all published products with "shirt" in the name

Behind the scenes, the agent runs:

shell
shoplazza products +search --keyword "shirt" --format table

Next steps​

On this page