Installation

Table Of Contents

• Installation
  • Table Of Contents
  • Quick Start
  • Prerequisites
  • cargo-binstall (recommended)
  • Windows (winget)
  • Arch Linux (AUR)
  • Nix flake
  • GitHub Releases
  • Docker
  • Build manually
  <!--toc:end-->

Quick Start

• Install via cargo-binstall (recommended):

cargo binstall rustowl

• Or install via your platform package manager (winget, AUR) or download from GitHub Releases. See below for full options.

This document collects supported installation methods and examples.

Prerequisites

• Rust toolchain (cargo). Install via rustup: https://rustup.rs/

cargo-binstall (recommended)

Install the prebuilt binary using cargo-binstall:

cargo binstall rustowl

This automatically downloads and unpacks a Rust toolchain if required.

Windows (winget)

Install with:

winget install rustowl

Arch Linux (AUR)

We provide AUR packages that either install prebuilt binaries or build from source. Prebuilt binaries (recommended):

yay -S rustowl-bin

Build from AUR (cargo build):

yay -S rustowl

Git (build from latest source):

yay -S rustowl-git

Replace yay with your AUR helper of choice.

Nix flake

There is a third-party Nix flake repository in the Nix community.

GitHub Releases

Download the rustowl executable from the release page:

https://github.com/cordx56/rustowl/releases/latest

Place the executable into a directory on your PATH.

Docker

Run the prebuilt image from GitHub Container Registry:

docker pull ghcr.io/cordx56/rustowl:latest

Run it against a project directory:

docker run --rm -v /path/to/project:/app ghcr.io/cordx56/rustowl:latest

Use an alias to act like a local CLI:

alias rustowl='docker run --rm -v $(pwd):/app ghcr.io/cordx56/rustowl:latest'

Build manually

See docs/build.md for detailed build instructions and how to build editor extensions.