Installation

Install Miblo for Rust API development on Windows, macOS or Linux. Rust, Cargo and rustfmt are required.

On this page

Prepare your environment

Install Rust 1.88 or later, Cargo and rustfmt through rustup. The formatter is used when generating and merging Rust code.

shell
rustup update stable
rustup component add rustfmt
rustc --version
cargo --version
SystemNative build tools
macOSCommand Line Tools: xcode-select --install
LinuxA C/C++ compiler and linker, such as build-essential on Debian/Ubuntu.
WindowsVisual Studio Build Tools with “Desktop development with C++”, and the Rust MSVC toolchain.

SQLite needs no database server. Python, Docker and sqlx-cli are not required to use Miblo.

Install

shell
cargo install miblo --version 0.9.1 --locked
miblo --version

This command installs or updates Miblo to the documented version. The first compilation can take several minutes. --locked keeps the tested dependency versions.

Install from a local checkout
shell
cargo install --path . --locked

Launch Miblo

shell
miblo

This opens the terminal workspace in English by default. Press Shift+L to choose English or Français; your choice is saved. A project is opened automatically when the current directory contains miblo.yaml.

shell
miblo ui --project path/to/my-api

Without an interactive terminal, bare miblo prints help. CLI subcommands are available for scripts.

Prebuilt binaries

Download a prebuilt Miblo 0.9.1 beta for your system:

Extract the archive and place miblo (or miblo.exe) in a directory on your PATH. On macOS/Linux, preserve its executable permission. Then run miblo --version in a terminal.

Rust, Cargo, rustfmt and native build tools are still required to compile generated APIs. These beta binaries are unsigned and not notarized; installation with Cargo builds Miblo from source.

Release notes and all archives. Templates are downloaded automatically on first use.

Command not found

Open a new terminal and check that Cargo’s binary directory is in your PATH: usually ~/.cargo/bin on Unix or %USERPROFILE%\.cargo\bin on Windows.

If linking fails, check your system’s native build tools. See troubleshooting for other errors.

Search for a feature or command.

↑ ↓ browse Enter to open