Files
2025-11-30 08:24:46 +08:00

4.2 KiB

CLI Commands Reference

Installation

npm install -g @elevenlabs/cli
# or
pnpm install -g @elevenlabs/cli

Authentication

Login

elevenlabs auth login

Check Current User

elevenlabs auth whoami

Set Residency

elevenlabs auth residency eu-residency
# Options: global | eu-residency | in-residency

Logout

elevenlabs auth logout

Project Initialization

Initialize New Project

elevenlabs agents init

Recreate Project Structure

elevenlabs agents init --override

Agent Management

Add Agent

elevenlabs agents add "Agent Name" --template TEMPLATE

Templates: default | minimal | voice-only | text-only | customer-service | assistant

Push to Platform

# Push all agents
elevenlabs agents push

# Push specific agent
elevenlabs agents push --agent "Agent Name"

# Push to environment
elevenlabs agents push --env prod

# Dry run (preview changes)
elevenlabs agents push --dry-run

Pull from Platform

# Pull all agents
elevenlabs agents pull

# Pull specific agent
elevenlabs agents pull --agent "Agent Name"

List Agents

elevenlabs agents list

Check Sync Status

elevenlabs agents status

Delete Agent

elevenlabs agents delete AGENT_ID

Generate Widget

elevenlabs agents widget "Agent Name"

Tool Management

Add Webhook Tool

elevenlabs tools add-webhook "Tool Name" --config-path tool_configs/tool.json

Add Client Tool

elevenlabs tools add-client "Tool Name" --config-path tool_configs/tool.json

Push Tools

elevenlabs tools push

Pull Tools

elevenlabs tools pull

Delete Tool

elevenlabs tools delete TOOL_ID

# Delete all tools
elevenlabs tools delete --all

Testing

Add Test

elevenlabs tests add "Test Name" --template basic-llm

Push Tests

elevenlabs tests push

Pull Tests

elevenlabs tests pull

Run Test

elevenlabs agents test "Agent Name"

Multi-Environment Workflow

# Development
elevenlabs agents push --env dev

# Staging
elevenlabs agents push --env staging

# Production
elevenlabs agents push --env prod --dry-run
# Review changes...
elevenlabs agents push --env prod

Common Workflows

Create and Deploy Agent

elevenlabs auth login
elevenlabs agents init
elevenlabs agents add "Support Bot" --template customer-service
# Edit agent_configs/support-bot.json
elevenlabs agents push --env dev
elevenlabs agents test "Support Bot"
elevenlabs agents push --env prod

Update Existing Agent

elevenlabs agents pull
# Edit agent_configs/agent-name.json
elevenlabs agents push --dry-run
elevenlabs agents push

Promote Agent to Production

# Test in staging first
elevenlabs agents push --env staging
elevenlabs agents test "Agent Name"

# If tests pass, promote to prod
elevenlabs agents push --env prod

Environment Variables

# For CI/CD
export ELEVENLABS_API_KEY=your-api-key

# Run commands
elevenlabs agents push --env prod

Troubleshooting

Reset Project

elevenlabs agents init --override
elevenlabs agents pull

Check Version

elevenlabs --version

Get Help

elevenlabs --help
elevenlabs agents --help
elevenlabs tools --help

File Locations

Config Files

~/.elevenlabs/api_key          # API key (if not using keychain)

Project Files

./agents.json                   # Agent registry
./tools.json                    # Tool registry
./tests.json                    # Test registry
./agent_configs/*.json          # Individual agent configs
./tool_configs/*.json           # Individual tool configs
./test_configs/*.json           # Individual test configs

Best Practices

  1. Always use --dry-run before pushing to production
  2. Commit configs to Git for version control
  3. Use environment-specific configs (dev/staging/prod)
  4. Test agents before deploying
  5. Pull before editing to avoid conflicts
  6. Use templates for consistency
  7. Document changes in commit messages