@creativiso/xpress-cli

Official CLI for the Creativiso Xpress public REST API.

Manage pages, articles, products, orders and more from the terminal — or feed it to an AI agent.

Installation

npm install -g @creativiso/xpress-cli

Quick Start

# Authenticate and add a site
xpress login

# List configured sites
xpress config list

# Set default language
xpress config set-lang bg

# View current configuration
xpress config show

Usage

xpress --help
xpress <command> --help
xpress <action> <resource> --help

# Examples
xpress list pages --limit 5
xpress get page 1 --json | jq '.title'
xpress list products --active 1 --json
xpress list orders --status pending
xpress list strings --group nav
xpress create article --slug my-post --title "My Post"
xpress update order 100 --status completed
xpress delete product 5

Commands

Authentication & Configuration

| Command | Description | |---------|-------------| | login | Add or update a site (interactive) | | logout | Remove current or specified site | | config list | List all configured sites | | config show [site] | Show details for a site | | config use [site] | Set the default site | | config remove <site> | Remove a site from config | | config set-lang <lang> | Set default language for a site |

Resource Actions

| Action | Description | |--------|-------------| | list <resource> | List resources (paginated) | | get <resource> <id> | Get a single resource by ID | | create <resource> | Create a new resource | | update <resource> <id> | Update an existing resource | | delete <resource> <id> | Delete a resource |

Available Resources

List resources:

• pages, articles, article-categories, products, product-categories
• product-attributes, attribute-values, product-variations, product-options
• product-raw-attrs <productId>, orders, strings, indexed-urls

Get resources:

• page, article, article-category, product, product-category
• product-attribute, product-variation, product-option, order, indexed-url

Create resources:

• page, article, article-category, product, product-category
• product-attribute, attribute-value, product-variation, product-option, order

Update resources:

• page, article, article-category, product, product-category
• product-attribute, attribute-value, product-raw-attr
• product-variation, product-option, order

Delete resources:

• page, article, article-category, product, product-category
• product-attribute, attribute-value, product-raw-attr
• product-variation, product-option, order, indexed-url

Global Flags

| Flag | Description | |------|-------------| | -s, --site <site> | Named site to use (overrides default) | | -t, --token <token> | API bearer token (overrides config) | | -u, --url <url> | API base URL (overrides config) | | -l, --lang <lang> | Language code (overrides config defaultLang) | | -j, --json | Output raw JSON (pipe-friendly) | | -q, --quiet | Suppress non-data output | | -v, --verbose | Print HTTP request details to stderr |

Pagination

For list commands that return paginated results:

| Flag | Description | |------|-------------| | -p, --page <n> | Page number, 1-based (computes offset automatically) | | -n, --page-size <n> | Items per page (alias: --limit, default: 20) | | --offset <n> | Raw offset — use --page instead when possible |

Documentation

See docs/ for detailed command references:

• AI Agent Guide
• Articles
• Pages
• Orders
• Products
• Product Categories
• Product Attributes
• Product Variations
• Product Options
• Article Categories
• Indexed URLs
• Strings

License

MIT