Installation

August 11, 2026 ยท View on GitHub

Note

RustAPI requires Rust 1.85 or later (MSRV). See the workspace Cargo.toml for the authoritative value.

Prerequisites

Before we begin, ensure you have the Rust toolchain installed. If you haven't, the best way is via rustup.rs.

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Installing the CLI

RustAPI comes with a powerful CLI to scaffold projects. Install it directly from crates.io:

cargo install cargo-rustapi

Verify your installation:

cargo-rustapi --version

Adding to an Existing Project

If you prefer not to use the CLI, you can add RustAPI to your Cargo.toml manually:

cargo add rustapi-rs@0.2.0

Or add this to your Cargo.toml:

[dependencies]
rustapi-rs = "0.2.0"

Editor Setup

For the best experience, we recommend VS Code with the rust-analyzer extension. This provides:

  • Real-time error checking
  • Intelligent code completion
  • In-editor documentation