shopq

A zero-dependency Shopify Admin CLI built on Bun. Manage products, pages, collections, menus, files, themes, and more from your terminal.

Built with AI agents as the primary user — structured JSON output, predictable exit codes, and no interactive prompts.

Install

CLI

bun install -g shopq

Pi coding agent

Install as a pi package to give your agent Shopify skills:

pi install npm:shopq

Prerequisites

• Bun v1.3+ (also works with Node.js v22+)
• A Shopify store with a Dev Dashboard app (see setup below)

Setup

1. Create a Shopify app

1. Go to the Shopify Dev Dashboard and create a new app
2. Configure the API scopes your app needs and release a version
3. Click Install app (top right of the app overview page) to install it on your store
4. Go to your app's Settings page and copy the Client ID and Secret

Your store URL is the xxx.myshopify.com domain shown in your Shopify admin sidebar.

2. Configure credentials

Create a .env file in your project directory:

SHOPIFY_STORE=your-store.myshopify.com
SHOPIFY_CLIENT_ID=your-client-id
SHOPIFY_CLIENT_SECRET=your-client-secret

Bun loads .env automatically — no extra setup needed. shopq handles the OAuth token exchange behind the scenes.

Development

git clone https://github.com/c99e/shopq.git
cd shopq
bun install

# Run locally without affecting a global shopq install
bun run bin/shopq.ts <command>

Usage

shopq <resource> <verb> [args] [flags]

Global flags

Flag	Description
--json, -j	Output as JSON
--help, -h	Show help
--version, -v	Print version
--store <url>	Store override
--no-color	Disable colored output (also respects NO_COLOR env)

Raw GraphQL

Every resource command is built on Shopify's Admin GraphQL API. When you need something the resource commands don't cover, gql gives you direct access:

# Inline query
shopq gql "{ shop { name email } }"

# From a file
shopq gql - < my-query.graphql

# With variables
shopq gql "mutation($id: ID!) { productDelete(input: {id: \$id}) { deletedProductId } }" --variables '{"id": "gid://shopify/Product/123"}'

This is the escape hatch — anything the Shopify Admin API supports, gql can do.

Commands

Store

Command	Description
shop get	Show store metadata
config show	Show current configuration

Products

Command	Description
product list	List products with filtering and pagination
product get	Get a single product by ID or title
product create	Create a product with optional variant support
product update	Update a product by ID or title
product delete	Delete a product by ID or title

Content

Command	Description
page list	List static store pages
page get	Get a single page by handle
page create	Create a static store page
page update	Update a static store page
page delete	Delete a static store page

Storefront

Command	Description
collection list	List collections with pagination
collection get	Get a single collection by ID or handle
menu list	List all navigation menus
menu get	Get a single menu by ID or handle

Assets

Command	Description
file list	List store files with filtering and pagination
theme list	List all themes

Examples

# List products
shopq product list --limit 10

# Get a product as JSON
shopq product get "T-Shirt" --json

# Create a product with variants
shopq product create --title "T-Shirt" --variants variants.json

# Get a page by handle
shopq page get --handle "about-us"

# List collections
shopq collection list --json

Testing

bun test

Contributing

Contributions are welcome! Please open an issue first to discuss what you'd like to change.

This project follows the Contributor Covenant code of conduct.

License

MIT