Xerxo OS CLI - Your AI-powered business operations assistant. Chat with agents, run workflows, manage tasks, and automate your business from the terminal.
Project description
Xerxo CLI
Your AI-powered business operations assistant. Any OS. Any Platform. The Xerxo way.
What is Xerxo?
Xerxo is an open-source CLI for AI-powered business operations. It connects to the Xerxo platform or runs as a self-hosted gateway, giving you:
- ๐ค AI Agents - Chat with intelligent agents that can use tools
- ๐ Workflows - Automate multi-step business processes
- โก Skills - Pre-built automations from the marketplace
- ๐ฑ Channels - WhatsApp, Telegram, Discord, Slack, Email
- ๐ฅ๏ธ Terminal UI - Beautiful full-screen interface
- ๐ Browser Automation - Control browsers with AI
- ๐ Self-Hosted - Run your own gateway, own your data
Quick Start
# Install
pip install xerxo
# Setup (interactive wizard)
xerxo setup
# Start chatting
xerxo agent chat
# Or launch the full Terminal UI
xerxo tui
Installation
Option 1: pip (Recommended)
# macOS / Linux
pip3 install xerxo
# Windows
pip install xerxo
# or
py -m pip install xerxo
Option 2: Homebrew (macOS/Linux)
brew tap xerxo/tap
brew install xerxo
Option 3: One-Line Installer
curl -fsSL https://xerxo.ai/install.sh | bash
Option 4: From Source
git clone https://github.com/xerxo/xerxo-cli
cd xerxo-cli
pip install -e .
Troubleshooting pip
"pip: command not found"
# macOS - Use pip3 or install via Homebrew
pip3 install xerxo
# or
brew install python && pip3 install xerxo
# Linux (Ubuntu/Debian)
sudo apt install python3-pip
pip3 install xerxo
# Linux (Fedora)
sudo dnf install python3-pip
pip3 install xerxo
Optional Features
# Browser automation (Playwright)
pip install xerxo[browser]
playwright install chromium
# Docker sandbox
pip install xerxo[docker]
# All optional features
pip install xerxo[all]
Commands
xerxo # Show help
โโโ setup # Interactive setup wizard
โโโ auth # Authentication
โ โโโ login # Login with credentials or API key
โ โโโ logout # Clear credentials
โ โโโ status # Show auth status
โ
โโโ agent # Agent interactions
โ โโโ chat # Interactive chat session
โ โโโ ask "<question>" # One-shot question
โ โโโ list # List agents
โ โโโ tools # Show available tools
โ โโโ config # View/edit agent config
โ
โโโ workflow # Workflow management
โ โโโ list # List workflows
โ โโโ run <id> # Execute workflow
โ โโโ status <run_id> # Check run status
โ โโโ logs <run_id> # View logs
โ
โโโ skill # Skills management
โ โโโ list # List installed skills
โ โโโ run <id> # Execute skill
โ โโโ marketplace # Browse marketplace
โ โ โโโ browse # List skills
โ โ โโโ install <id> # Install skill
โ โ โโโ search <query> # Search skills
โ โโโ publish <id> # Publish to marketplace
โ
โโโ task # Task management
โ โโโ list # List tasks
โ โโโ add "<title>" # Create task
โ โโโ complete <id> # Complete task
โ โโโ delete <id> # Delete task
โ
โโโ channel # Channel management
โ โโโ list # List channels
โ โโโ status # Health status
โ โโโ connect <type> # Connect channel
โ โโโ login # WhatsApp QR login
โ
โโโ browser # Browser automation
โ โโโ start # Start browser
โ โโโ navigate <url> # Navigate to URL
โ โโโ screenshot # Take screenshot
โ โโโ click <selector> # Click element
โ โโโ type <text> # Type text
โ
โโโ gateway # Self-hosted gateway
โ โโโ start # Start gateway server
โ โโโ stop # Stop gateway
โ โโโ status # Gateway status
โ โโโ logs # View logs
โ
โโโ tui # Full terminal UI
โโโ config # CLI configuration
โ โโโ set <key> <value> # Set config
โ โโโ get <key> # Get config
โ โโโ list # Show all config
โ
โโโ version # Show version
Terminal UI
Launch the full-screen terminal interface:
xerxo tui
Features:
- ๐ฌ Chat panel with streaming responses
- ๐ง Tool execution visibility
- ๐ Session sidebar
- โจ๏ธ Vim-style keyboard navigation
- ๐จ Beautiful Rich formatting
Self-Hosted Gateway
Run your own gateway server:
# Start gateway
xerxo gateway start --port 8080
# Connect WhatsApp
xerxo channel login --channel whatsapp
# Check status
xerxo gateway status
Configuration
Config is stored at ~/.xerxo/config.yaml:
api_url: https://api.xerxo.ai # Or your self-hosted URL
api_key: xrx_... # API key
default_agent: main # Default agent
output_format: rich # rich | json | plain
gateway:
port: 8080
bind: localhost
Environment Variables
XERXO_API_URL=https://api.xerxo.ai
XERXO_API_KEY=xrx_...
XERXO_CONFIG_DIR=~/.xerxo
What's Open Source vs Proprietary?
Open Source (This Repo - MIT License):
- CLI client and all commands
- Terminal UI (TUI)
- Local gateway server
- Sandbox execution
- Browser automation
- Tool handlers
Proprietary (Xerxo Cloud):
- Hosted platform (web UI)
- Enterprise features (teams, RBAC, audit)
- Premium skills & workflows
- Support & SLAs
Contributing
We welcome contributions! See CONTRIBUTING.md.
# Clone
git clone https://github.com/xerxo/xerxo-cli
cd xerxo-cli
# Install dev dependencies
pip install -e ".[dev]"
# Run tests
pytest
# Format code
black xerxo/
ruff check xerxo/
License
MIT License - see LICENSE for details.
Links
- ๐ Documentation
- ๐ฌ Discord Community
- ๐ Report Issues
- ๐ Xerxo Platform
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file xerxo-1.0.2.tar.gz.
File metadata
- Download URL: xerxo-1.0.2.tar.gz
- Upload date:
- Size: 43.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5158dc981a939a421482a2d73aba50cca80523f6a0e5bf688026d7c1698a7793
|
|
| MD5 |
6c79b91aab9f4b0ad06cf4b4bb340fdd
|
|
| BLAKE2b-256 |
ac761d7b63f92ebccfb61fb6b0a67a9d99457e3c80405c0b21c2932dbda4164a
|
File details
Details for the file xerxo-1.0.2-py3-none-any.whl.
File metadata
- Download URL: xerxo-1.0.2-py3-none-any.whl
- Upload date:
- Size: 41.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
49f73f024b0ac979d921e934a0b1cad279ae5402d70e2dc461fa327bd70a201c
|
|
| MD5 |
8a9a2f57d6ac3cd5875d81c0aaee3e1e
|
|
| BLAKE2b-256 |
43d1bf150b3dadd90693652212ca087e5e2bc414efca3ee4b326374414cb471e
|