Zen CLI

Command-line client for the Zen Partner API. Search customers, manage loyalty cards, look up transactions, and more.

Installation

🐧

Linux / macOS

Auto-detects platform, verifies checksum, adds to PATH

curl -fsSL https://downloads.zenglobal.au/cli/install.sh | sh

🪟

Windows (PowerShell)

Auto-detects platform, verifies checksum, adds to PATH

irm https://downloads.zenglobal.au/cli/install.ps1 | iex

Getting Started

Configure credentials

zg config login

Enter your API key and secret when prompted. Credentials are stored in ~/.config/zg/config.yaml.

Verify connection

zg config test

Start using

# Search for a customer
zg customer search --email user@example.com

# List loyalty cards
zg loyalty cards search --card-number 1234

# Get site info
zg site list --json

Commands

Command	Description
`zg config`	Manage configuration and API profiles
`zg customer`	Customer operations
`zg email`	Email validation
`zg inventory`	Inventory search and lookup
`zg loyalty`	Loyalty cards, points, settings, groups
`zg membership`	Membership management
`zg offer`	Offer search and management
`zg order`	Order operations
`zg site`	Site listing and search
`zg transaction`	Transaction lookup
`zg voucher`	Voucher search and redemption
`zg system`	System health and API version
`zg mcp serve`	Start MCP server for AI agent integration
`zg version`	Show CLI version and build info
`zg update`	Self-update to latest version

Global Flags

--json Output as JSON

--profile Named profile

--api-key Override key

--api-secret Override secret

--api-url Override URL

--verbose Debug info

--no-color Plain output

Multiple Profiles

# Add a second profile
zg config login --profile staging

# Use it
zg site list --profile staging

AI Agent Integration

Model Context Protocol (MCP)

The CLI includes a built-in MCP server. AI agents can discover and invoke all CLI commands programmatically.

zg mcp serve

All CLI commands are automatically exposed as MCP tools with full parameter schemas.