Skip to content

CLI Reference

Terminal window
# Start server
rcommerce serve [-c config.toml] [-H host] [-P port]
# Show version
rcommerce --version
Terminal window
# Run migrations
rcommerce db migrate
# Reset database
rcommerce db reset
# Seed with sample data
rcommerce db seed
# Show status
rcommerce db status
Terminal window
# List products
rcommerce product list [--page 1] [--per-page 20]
# Get product
rcommerce product get <id>
# Create product
rcommerce product create --title "Product Name" --price 29.99 --sku "SKU-001"
Terminal window
# List orders
rcommerce order list [--status confirmed] [--page 1]
# Get order
rcommerce order get <id>
Terminal window
# Create API key
rcommerce api-key create --name "My App" --scopes "products:read,orders:write"
# List API keys
rcommerce api-key list
# Get API key details
rcommerce api-key get <prefix>
# Revoke API key
rcommerce api-key revoke <prefix> --reason "No longer needed"
# Delete API key
rcommerce api-key delete <prefix>
# Update scopes
rcommerce api-key update <prefix> --scopes "read"
Terminal window
# Import from platform
rcommerce import platform <platform> \
--api-url <url> \
--api-key <key> \
--api-secret <secret> \
--entities products,customers,orders \
[--dry-run] \
[--overwrite]
# Supported platforms: woocommerce, shopify, magento, medusa
Terminal window
# Show current config
rcommerce config
# Validate config
rcommerce config validate
PresetScopes
readRead access to all resources
writeRead + write access to all resources
adminFull admin access
customerproducts:read, carts:read/write, orders:read/write, customers:read/write
Terminal window
rcommerce api-key create --name "Reader" --scopes "read"