Skip to main content
Your generated CLI organizes commands around your API’s resources and actions.

​
Command structure

your-cli <resource> <action> [flags]
For example, if your API has a users resource: 
your-cli users list
your-cli users get --id user_123
your-cli users create --name "Jane" --email "jane@example.com"
your-cli users delete --id user_123

​
Global flags

These flags are available on every command:
FlagDescription
--api-keyAPI key for authentication
--base-urlOverride the default API base URL
--outputOutput format: table, json, or raw
--jsonShorthand for --output json
--rawShorthand for --output raw

​
Getting help

Every command has built-in help: 
# See all available resources
your-cli --help

# See actions for a specific resource
your-cli users --help

# See flags for a specific action
your-cli users create --help

​
Example workflow

# Set your API key once
your-cli configure --api-key sk-your-key-here

# List resources
your-cli users list

# Get a specific resource as JSON
your-cli users get --id user_123 --json

# Create a new resource
your-cli users create --name "Jane" --email "jane@example.com"