GitHub - oxy-hq/oxy: Oxygen is the AI data analyst built for speed and precision.

3 min read Original article ↗

License

view - Documentation

📖 Looking for up-to-date code documentation?
Check out our DeepWiki, which updates weekly with the latest code changes: DeepWiki

Oxygen is the open-source AI data analyst built for speed and precision. Written in Rust and declarative by design, Oxygen provides the foundational components needed to transform AI-driven data analysis into reliable, production-ready systems through structured primitives, semantic understanding, and predictable execution.

Using Oxygen, users can automate data Q&A and reporting, and accelerate building data artifacts such as semantic topics and data applications.

Oxygen integrates natively with your existing data stack - data warehouses, ELT tools, semantic layers, and BI tools. Oxygen also comes with its own data tools for a zero-config experience.

To learn more, read our docs.

Quickstart

To install Oxygen from binary, run the following command (Mac, Linux, WSL):

bash <(curl -sSfL https://get.oxy.tech)
Alternative Installation Methods

Using Homebrew (macOS only)

brew install oxy-hq/oxy/oxy

Installing a Specific Version

OXY_VERSION="0.1.0" bash <(curl -sSfL https://get.oxy.tech)

Installing Edge Builds

To install the latest edge build (built from main branch):

bash <(curl -sSfL https://nightly.oxy.tech)

To install a specific edge version:

OXY_VERSION=edge-7cbf0a5 bash <(curl -sSfL https://nightly.oxy.tech)

Browsing Available Releases

To list all available releases across stable and edge channels:

bash <(curl -sSfL https://release.oxy.tech)

Filter by channel or adjust the number of results:

bash <(curl -sSfL https://release.oxy.tech) --channel stable
bash <(curl -sSfL https://release.oxy.tech) -c edge -n 20

You can also browse releases directly on GitHub: stable | edge.

To verify the installation, run:

Quick Deploy

Deploy the complete Oxygen demo application with one click:

This deployment includes:

  • ✅ Complete Oxygen application (Rust backend + React frontend)
  • ✅ Demo retail analytics project with Oxygenmart dataset
  • ✅ Pre-configured workflows and data apps
  • ✅ Persistent storage for databases
  • ✅ Free tier available

Deployment Steps

  1. Prerequisites: Install the Fly CLI

    curl -L https://fly.io/install.sh | sh
  2. Login to Fly.io:

  3. Deploy:

    Follow the prompts to:

    • Choose your app name and region
    • Create a persistent volume for data storage
    • The deployment will automatically use Dockerfile.demo with the demo_project included
  4. Set your API key (required for AI features):

    fly secrets set OPENAI_API_KEY=sk-your-key-here
  5. Access your app:

Your Oxygen instance will be live at https://your-app-name.fly.dev with the complete demo project ready to explore!

Database

Oxygen uses PostgreSQL for all deployments. For local development, an embedded PostgreSQL instance starts automatically - no setup required!

For production deployments, configure an external PostgreSQL database:

export OXY_DATABASE_URL=postgresql://user:password@host:port/database

See DEVELOPMENT.md for more details about database configuration and migration.


See our docs on how to modify the agent file, seed it with context, run tests, and create workflows.