Skip to main content

Installation

Get started with async-inspect in minutes.

Quick Install​

From crates.io​

cargo install async-inspect

From Source​

git clone https://github.com/ibrahimcesar/async-inspect
cd async-inspect
cargo install --path .

Verify Installation​

async-inspect --version

You should see:

async-inspect 0.1.0

Add to Your Project​

As a Library​

Add to your Cargo.toml:

[dependencies]
async-inspect = "0.1.0"

With Features​

[dependencies]
async-inspect = { version = "0.1.0", features = ["cli", "prometheus-export"] }

Available features:

  • cli - Terminal UI and CLI tools
  • tokio - Tokio runtime integration (default)
  • tracing-sub - Tracing subscriber integration
  • prometheus-export - Prometheus metrics
  • opentelemetry-export - OpenTelemetry traces
  • full - All features enabled

Development Dependencies​

For examples and testing:

[dev-dependencies]
tokio = { version = "1.35", features = ["full"] }
async-inspect = { version = "0.1.0", features = ["cli"] }

System Requirements​

  • Rust: 1.70 or later
  • OS: Linux, macOS, Windows
  • Optional: Node.js 20+ (for documentation site)

VS Code Extension​

Install the async-inspect extension from VS Code Marketplace:

  1. Open VS Code
  2. Go to Extensions (Cmd+Shift+X / Ctrl+Shift+X)
  3. Search for "async-inspect"
  4. Click Install

Or install from VSIX:

code --install-extension async-inspect-0.1.0.vsix

Troubleshooting​

Command Not Found​

If async-inspect command is not found after installation:

# Add cargo bin to PATH
export PATH="$HOME/.cargo/bin:$PATH"

# Or use full path
~/.cargo/bin/async-inspect --version

Build Errors​

If you get compilation errors:

  1. Update Rust:

    rustup update stable

  2. Clean build cache:

    cargo clean
    cargo install async-inspect

Feature Conflicts​

If you see feature-related errors, make sure you're using compatible features:

# ✅ GOOD
[dependencies]
async-inspect = { version = "0.1.0", features = ["cli", "tokio"] }

# ❌ BAD - conflicting features
[dependencies]
async-inspect = { version = "0.1.0", features = ["cli"], default-features = false }
tokio = { version = "1.0", features = ["rt"] }  # May conflict

Next Steps​

← Back to Intro | Quick Start →