Skip to content

GhostKellz/oxygen

Repository files navigation

Oxygen Logo

Oxygen

The essential Rust dev environment enhancer

Rust Tool Type Platform Status

Oxygen (oxy) is a clean, fast, and extendable CLI utility designed to make Rust development smoother, smarter, and more efficient — without replacing Cargo.

Whether you're hacking on side projects, managing a clean dotfile stack, or maintaining complex dev workflows across systems, Oxygen acts as your essential sidekick.


🚀 Features

⚙️ Cargo Enhancements

  • oxy build: Build with enhanced timing and size summaries
  • oxy check: Run clippy, fmt, and cargo check together
  • oxy test --watch: Auto-retest failing tests
  • oxy clean --deep: Remove build cache, target, stale deps

🧰 DevOps Tools

  • oxy doctor: Diagnose broken rustup paths, toolchain mismatches, env issues
  • oxy env: Summarize current Rust environment, toolchains, config
  • oxy tools: Inspect installed tools (rustfmt, zls, lldb, etc.)

📦 Project Intelligence

  • oxy info: Show project metadata, git status, Cargo.toml preview
  • oxy size: Show binary size breakdowns and compile stats
  • oxy snapshot: Save current dev state as a snapshot (build + git diff)

🖥 Workflow Utilities

  • oxy init: Project scaffolding wizard (custom or cargo)
  • oxy shell: Start a dev shell with tools + paths preloaded
  • oxy run: Run with profiling/stats overlays

🧠 Why Oxygen?

  • Rust-first: Built in Rust, for Rust
  • Cargo-aligned: Never overrides cargo — enhances it
  • Cross-platform: Linux, macOS, and Windows-ready
  • Lightweight: Single binary, no deps
  • Extensible: Add your own workflows, aliases, and build scripts

🔧 Installation

Quick Install (Linux/macOS)

curl -sSL https://raw.githubusercontent.com/ghostkellz/oxygen/main/install.sh | bash

Arch Linux

# Using the PKGBUILD from this repo
git clone https://github.com/ghostkellz/oxygen.git
cd oxygen
./build-arch-package.sh stable
sudo pacman -U oxygen-*.pkg.tar.*

# Or build git version
./build-arch-package.sh git

From Source

# Prerequisites: Rust toolchain
cargo install --git https://github.com/ghostkellz/oxygen

# Or clone and build
git clone https://github.com/ghostkellz/oxygen
cd oxygen
cargo build --release
sudo cp target/release/oxygen /usr/local/bin/oxy

Verify Installation

oxy --version
oxy doctor  # Check your Rust environment

📝 Usage Examples

oxy check           # Runs clippy + fmt + check
oxy build           # Builds and shows size/timing info
oxy run --profile   # Runs with perf overlay
oxy tools           # Lists installed Rust-related dev tools
oxy doctor          # Diagnoses common environment issues

Stay fast. Stay focused. Stay Rusty. 🦀

About

The essential Rust dev environment enhancer

Resources

License

Stars

Watchers

Forks

Packages

No packages published