Skip to main content

An intelligent agent with BYOK for managing cloud infrastructure & bash env

Project description

Xerxes

An intelligent DevOps agent with unrestricted CLI access and free-form reasoning

License: MIT Python 3.10+ Code style: black

FeaturesInstallationQuick StartDocumentationContributing


Overview

Xerxes is an intelligent DevOps assistant that transforms natural language into bash commands. Unlike traditional tools with predefined commands, Xerxes leverages full bash capabilities with intelligent resource discovery to execute complex operations across your entire infrastructure.

Features

Core Capabilities

  • Full Bash Shell Access: Execute ANY command with complete shell features
    • Pipes, redirection, chaining (|, >, >>, &&, ||)
    • Variables, loops, conditionals, subshells
    • Process substitution and command expansion
  • Intelligent Resource Discovery: Automatic fuzzy matching and pattern-based discovery
    • Never assumes exact names - always discovers first
    • Pattern: SEARCH → MATCH → OPERATE
    • Works with files, pods, containers, instances, and more
  • Token-Efficient Operations: Minimal output formatting for faster responses
    • Uses -o name, --format, --query flags
    • Field projection to reduce token usage
  • Interactive Approval: See command + reasoning before execution
    • [R]un - Execute this command
    • [S]kip - Skip and continue
    • [A]lways - Auto-approve for session
  • Multi-Cloud & Multi-Tool: kubectl, docker, aws, gcloud, helm, jq, ffmpeg, git, and more
  • Safety First: Automatic detection of destructive operations with confirmation prompts

Installation

Using UV (Recommended)

uv tool install xerxes

To update to the latest version:

uv tool upgrade xerxes

From Source

git clone https://github.com/shammianand/xerxes.git
cd xerxes
uv sync

Quick Start

1. Prerequisites

  • Python 3.10+
  • GCP Project with Vertex AI API enabled
  • Service Account or API key for Vertex AI
  • Optional: Install CLI tools you want to use (kubectl, docker, aws, gcloud)

2. Configuration

Create a .env file:

XERXES_VERTEX_PROJECT_ID=your-gcp-project-id
XERXES_VERTEX_LOCATION=us-central1
XERXES_VERTEX_MODEL=gemini-2.0-flash
XERXES_GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json

Or use the CLI:

xerxes config set vertex_project_id your-gcp-project-id
xerxes config set google_application_credentials /path/to/sa.json

3. Start Chatting

xerxes chat

Usage

Example Session

https://github.com/user-attachments/assets/350d91eb-b999-4c18-aba3-52d4e430bb8e

Operations:

"Scale the api deployment to 5 replicas"
"Delete all pods in failed state"
"Create a new GCS bucket for backups"

CLI Commands

# Start interactive chat
xerxes chat

# Manage configuration
xerxes config show
xerxes config set <key> <value>

# List available tools
xerxes tools

# Show version
xerxes version

Configuration Options

Variable Description Default
XERXES_VERTEX_PROJECT_ID GCP project ID (required) -
XERXES_VERTEX_LOCATION GCP region us-central1
XERXES_VERTEX_MODEL Model name claude-3-5-sonnet@20240620
XERXES_GOOGLE_APPLICATION_CREDENTIALS Path to service account JSON -
XERXES_MAX_TOKENS Max tokens per response 4096
XERXES_TEMPERATURE LLM temperature 0.0

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests and linters:
    uv run pytest
    uv run black src/
    uv run ruff check src/
    
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Development Setup

# Clone the repo
git clone https://github.com/shammianand/xerxes.git
cd xerxes

# Install dependencies
uv sync --all-extras

# Run in development mode
uv run xerxes chat

Roadmap

  • Additional LLM providers (Anthropic direct, OpenAI, Ollama)
  • Terraform integration
  • Ansible playbook execution
  • Multi-step workflow automation
  • Session history save/replay
  • Web dashboard for monitoring
  • Plugin system for custom tools
  • One-shot command mode (xerxes run "list all pods")

License

MIT License - see LICENSE for details

Support


Built with ❤️ by Shammi Anand

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xerxes-0.3.1.tar.gz (97.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xerxes-0.3.1-py3-none-any.whl (23.5 kB view details)

Uploaded Python 3

File details

Details for the file xerxes-0.3.1.tar.gz.

File metadata

  • Download URL: xerxes-0.3.1.tar.gz
  • Upload date:
  • Size: 97.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.5

File hashes

Hashes for xerxes-0.3.1.tar.gz
Algorithm Hash digest
SHA256 03193b82002a4b77b0437cc9dbbe2507bc612a766df5de6817dd5e1005476b9c
MD5 9c5be01328eb8df1d0f9bc47d47891c3
BLAKE2b-256 ecd980cb5b394acd9c3c144787983c037588134848275255691b6c9a05368c40

See more details on using hashes here.

File details

Details for the file xerxes-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: xerxes-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 23.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.5

File hashes

Hashes for xerxes-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f414bb69338157d6df660e4fdf54880a1965d5ea5cac10acfb4ee14c4e97fc89
MD5 d2a03b0ad3b3f234876104b1f2dbd20d
BLAKE2b-256 6a66f813855144402e253f4279785fc4e9c90b05cdde2987de4eb7e084059e05

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page