Vex

Your vendure admin-api graphql query executor. CLI tool and MCP server for the Vendure Admin GraphQL API.

Use vex from your terminal to manage products, customers, and orders — or connect it as an MCP server so Claude can do it for you.

Features

• Environment management — add, switch, configure, and health-check multiple Vendure instances
• Interactive query builder — pick an operation, prompt for variables (with proper type coercion), choose fields, and run
• Typed resource commands — CRUD for customers, products, orders, channels, zones, and tax out of the box
• Schema-aware — fetch and cache your Vendure schema (works with custom plugins) and introspect it from the CLI or MCP
• Reusable building blocks
  • Fragments — named field selections you can reuse across operations
  • Saved operations — full queries/mutations with their default variables, replayable via vex run
• Raw GraphQL — run any query or mutation directly when you need the escape hatch
• MCP server — expose every command and saved operation as tools so Claude can chain them via natural language

Installation

npm install -g @spaceparrots/vex

This puts the vex command on your PATH.

Requirements

Vendure 3.6+ is required. Vex uses the API key authentication method introduced in Vendure 3.6.

To set up your Vendure instance:

1. Enable API key auth in your Vendure config:

   authOptions: {
       tokenMethod: ['cookie', 'bearer', 'api-key'],
   }
   

2. Go to Settings > API Keys in the Vendure dashboard
3. Create a new key, assign the roles/permissions it needs, and copy the key (it's shown only once)

The key is sent via the vendure-api-key header on every request.

Quick start

# Add an environment — interactive wizard prompts for missing values and validates by fetching the schema
vex env add dev

# Or non-interactive
vex env add dev --url http://localhost:3000/admin-api --api-key sk-123456

# Verify it's healthy
vex env status dev

# Build a query interactively (pick fields, fill variables, see the GraphQL document)
vex build -q customers

# Save the built query for replay
vex build -q contents --save ContentsPublished

# Replay it later, optionally overriding variables
vex run ContentsPublished --var "options={\"take\":5}"

# Fetch and cache the schema (auto-fetched on first use)
vex schema fetch

CLI reference

Environment management

vex env add <name> [--url <url>] [--api-key <key>]   # Interactive when --url or --api-key is missing.
                   [--schema-type endpoint|file]      # Validates by fetching the schema (or reading the SDL file).
                   [--schema-value <value>]
                   [--no-validate]
vex env list                                          # List all environments
vex env switch <name>                                 # Switch active environment
vex env set <name> [--url <url>] [--api-key <key>]    # Update environment fields
vex env remove <name>                                 # Remove environment
vex env show <name>                                   # Show environment details (API key masked)
vex env status <name> [--json]                        # Check endpoint reachability + schema accessibility

Targeting a specific environment

vex resolves the environment for each operation in this order:

1. An explicit name — the env parameter on any MCP tool, or --env <name> on any CLI command.
2. The VEX_ENV environment variable — handy as a per-project default.
3. The globally active environment (`v

... View full README on GitHub