Quick Start

Get up and running with Oxid in under 5 minutes. Use your existing Terraform configuration - no changes needed.

1. Install Oxid

curl -fsSL https://raw.githubusercontent.com/ops0-ai/oxid/main/install.sh | bash

2. Navigate to Your Project

Oxid works with existing Terraform configurations. Navigate to any directory with .tf files:

cd my-terraform-project/
ls *.tf
# main.tf  variables.tf  outputs.tf  terraform.tfvars
TipOxid reads your .tf files natively - no conversion or wrapper needed. Variables, outputs, providers, data sources all work.

3. Initialize

Download providers and create the local state database:

oxid init

This creates a .oxid/ directory with:

  • .oxid/oxid.db - SQLite state database
  • .oxid/providers/ - Cached provider binaries
NoteIf you have an existing Terraform state file, Oxid will automatically import resources from it during init.

4. Plan

Preview what Oxid will create, update, or destroy:

oxid plan

The plan output uses the same +, ~, - symbols as Terraform.

5. Apply

Apply the changes to your infrastructure:

oxid apply

You will be prompted to confirm. To skip the prompt:

oxid apply --auto-approve

6. Explore

Once applied, explore your infrastructure:

# List all managed resources
oxid state list

# Query state with SQL
oxid query "SELECT address, status FROM resources"

# Check blast radius of a resource
oxid blast-radius aws_vpc.main

# View resource change history
oxid history aws_vpc.main

# Detect configuration drift
oxid drift

# Show outputs
oxid output --json

Next Steps