Start building for customer accounts
Get started building customer account UI extensions by setting up your development environment. You'll use Shopify CLI to generate starter code for building your extension and automating common development tasks.
Anchor to General requirementsGeneral requirements
- You're a user with app development permissions and have created a dev store.
- You're using the latest version of Shopify CLI.
- You're using the latest version of Chrome or Firefox.
- The dev store should be pre-populated with test data, including an order that's associated with the email address you'll use to log in to the customer account experience.
Anchor to Step 1: (Optional) Set up the Shopify AI ToolkitStep 1: (Optional) Set up the Shopify AI Toolkit
Install the Shopify AI Toolkit to connect your AI coding assistant to Shopify's docs, APIs, and CLI. Your assistant gets the Shopify context it needs to answer questions, write code, and run commands more reliably.
Claude Code
In your terminal, run claude plugin install:
Terminal
Codex
In your terminal, run codex plugin add:
Terminal
Antigravity CLI
In your terminal, install the Shopify plugin:
Terminal
Cursor
In Cursor Chat, add the Shopify plugin:
Cursor Chat
Hermes
In your terminal, download the install script and run it:
Terminal
VS Code
-
Ensure the Agent plugins preview is enabled in your VS Code settings.
-
Open the Command Palette (
Cmd+Shift+Pon macOS,Ctrl+Shift+Pon Windows/Linux) and run:VS Code: Command Palette
Chat: Install Plugin From Source -
When prompted, enter the repository URL:
VS Code: Plugin source URL
https://github.com/Shopify/shopify-ai-toolkit
In your terminal, run claude plugin install:
Terminal
Anchor to Step 2: Set up your development environmentStep 2: Set up your development environment
-
Run the following command to scaffold an app:
Terminal
shopify app init -
Select
Build an extension-only app. -
Navigate to your app directory:
Terminal
cd <directory> -
Run the following command to create a new extension:
Terminal
shopify app generate extension --name my-extension -
Choose
Customer account UI. -
Start your development server to build your app and preview your extension:
Terminal
shopify app dev
Anchor to Next stepsNext steps
- Build an inline extension that displays loyalty points and enables customers to leave a review.
- Build an order action menu extension that enables customers to report problems with their orders.
- Build a full-page extension for customers to add and edit products on a wishlist.
- Explore the customer account UI extensions reference for available targets, target APIs, and web components.