Skip to main content

Get started with Shoplazza AI Toolkit

The AI Toolkit runs on Shoplazza CLI, so setup is four steps: install the CLI, add the skills, authenticate, then prompt your agent. One command installs the skills into whichever agent you already use.

Requirements​

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

The command detects the agents installed on your machine, puts the skill files in ~/.agents/skills/, and links or exposes them to each agent. To target one agent, add -a <agent>. For the domain list and how skills work, see Agent Skills.

Claude Code​

shell
npx skills add Shoplazza/shoplazza-cli -g -a claude-code

The skill files land in ~/.agents/skills/, symlinked into ~/.claude/skills/.

To confirm they loaded, type / in Claude Code: shoplazza-products and the other skills appear in the list.

To invoke one, send /shoplazza-products Show me all published products with "shirt" in the name.

Codex CLI​

shell
npx skills add Shoplazza/shoplazza-cli -g -a codex

Codex CLI reads ~/.agents/skills/ directly, so no symlink is created. The same skills also work in the Codex IDE extension.

To confirm they loaded, run /skills, or type $ to open the skill picker. Codex detects skill changes on its own; if the skills don't show up, restart Codex.

To invoke one, send $shoplazza-products Show me all published products with "shirt" in the name.

Cursor IDE​

shell
npx skills add Shoplazza/shoplazza-cli -g -a cursor

The Cursor IDE reads ~/.agents/skills/ directly, alongside ~/.cursor/skills/.

To confirm they loaded, open Customize → Skills in the sidebar and check the discovered skills.

To invoke one, type / in Agent chat, search for the skill name, then send /shoplazza-products Show me all published products with "shirt" in the name.

Gemini CLI​

shell
npx skills add Shoplazza/shoplazza-cli -g -a gemini-cli

Gemini CLI reads ~/.agents/skills/ at the user level, which takes precedence over ~/.gemini/skills/.

To confirm they loaded, run /skills list. After changing a skill, run /skills reload.

Gemini CLI has no /skill-name syntax — name the skill in plain language instead: Use the shoplazza-products skill to show me all published products with "shirt" in the name.

Antigravity CLI​

shell
npx skills add Shoplazza/shoplazza-cli -g -a antigravity-cli

The skill files are installed into Antigravity CLI's global skills directory, ~/.gemini/antigravity-cli/skills/. Antigravity also reads .agents/skills/ inside the current workspace.

To confirm they loaded, start a new conversation and ask the agent to list its available skills — Antigravity shows the agent every skill's name and description at the start of a conversation.

Antigravity has no /skill-name syntax — name the skill in plain language instead: Use the shoplazza-products skill to show me all published products with "shirt" in the name.

GitHub Copilot​

In VS Code, install the GitHub Copilot extension and sign in first, then run:

shell
npx skills add Shoplazza/shoplazza-cli -g -a github-copilot

Personal skills are read from ~/.agents/skills/.

To confirm they loaded, type /skills in the chat input to open the Configure Skills menu.

To invoke one, send /shoplazza-products Show me all published products with "shirt" in the name — each skill is available as a slash command.

3. Authenticate​

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

This opens your browser for OAuth authorization and stores the credentials encrypted in the CLI's config directory. Verify with shoplazza auth status. For UAT/CI login and store switching, see Authentication.

tip

To have your agent walk you through the login instead, send /shoplazza-common log me in to my-store.myshoplaza.com. 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

The prefix differs per agent: Claude Code, Cursor IDE, and GitHub Copilot use /, Codex CLI uses $, and Gemini CLI and Antigravity CLI take a plain-language mention of the skill name. See the agent sections under Add the Agent Skills.

Behind the scenes, the agent runs:

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

Next steps​

On this page