Installation¶

OxideShield™ can be installed in multiple ways depending on your use case.

Rust Library¶

Add to your Cargo.toml:

[dependencies]
oxide-guard = "0.1"

Feature Flags¶

Core guards (Pattern, Length, Encoding, PII, Toxicity, Perplexity) are always available with no feature flags required.

Feature	Description	Dependencies
`semantic`	ML-based SemanticSimilarityGuard + MLClassifierGuard	Candle, Tokenizers, oxide-embeddings
`telemetry`	OpenTelemetry metrics export	opentelemetry
`bundled-embeddings`	Pre-computed attack embeddings for offline use	-
`licensing`	License validation for premium features	oxide-license
`full`	All features	All

# Basic usage - all core guards included
oxide-guard = "0.1"

# With ML guards
oxide-guard = { version = "0.1", features = ["semantic"] }

# All features
oxide-guard = { version = "0.1", features = ["full"] }

Python Package¶

Supported Python versions: 3.9, 3.10, 3.11, 3.12, 3.13, 3.14

Pre-built wheels are available for Linux, macOS, and Windows (x86_64 and ARM64). No Rust toolchain required.

# Using uv (recommended)
uv pip install oxideshield

# Using pip
pip install oxideshield

CLI Tool¶

From Cargo¶

cargo install oxide-cli

Pre-built Binaries¶

Download pre-built binaries for your platform from oxideshield.ai/downloads.

Shell Completions¶

# Bash
oxideshield completion bash > /etc/bash_completion.d/oxideshield

# Zsh
oxideshield completion zsh > ~/.zsh/completions/_oxideshield

# Fish
oxideshield completion fish > ~/.config/fish/completions/oxideshield.fish

WASM Package¶

npm install @oxideshield/wasm

Docker¶

Pre-built images are available on Docker Hub:

# Pull the latest image
docker pull oxideshield/proxy:latest

# Run the proxy
docker run -p 8080:8080 oxideshield/proxy --listen 0.0.0.0:8080

Available tags: - latest - Latest stable release - x.y.z - Specific version (e.g., 0.1.0) - slim - Minimal image without ML features

Verify Installation¶

Rust¶

use oxide_guard::{Guard, PatternGuard};

fn main() {
    let guard = PatternGuard::new("test");
    let result = guard.check("Hello world");
    println!("OxideShield™ working: {}", result.passed);
}

Python¶

from oxideshield import pattern_guard

guard = pattern_guard()
result = guard.check("Hello world")
print(f"OxideShield™ working: {result.passed}")

CLI¶

oxideshield --version
# oxideshield 0.1.0

oxideshield guard --input "Hello world"
# ✓ Passed all guards

System Requirements¶

Component	Minimum	Recommended
CPU	2 cores	4+ cores
Memory	512 MB	2+ GB
Disk	100 MB	500 MB (with models)
OS	Linux, macOS, Windows	Linux

ML Features¶

ML-based guards (semantic feature) have additional requirements:

Memory: 2+ GB for model loading
First Run: ~30s to download MiniLM model (~22 MB)
Disk: 500 MB for model cache

Troubleshooting¶

Python Import Errors¶

If you encounter import errors after installation:

# Reinstall the package
pip uninstall oxideshield
pip install oxideshield

# Or with uv
uv pip uninstall oxideshield
uv pip install oxideshield

Version Compatibility¶

Check your Python version is supported (3.9 - 3.14):

python --version

Contact Support¶

For installation issues, contact our support team or visit oxideshield.ai/support.