Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Installation

Quick install (recommended)

The installer detects your OS and architecture, downloads a prebuilt binary, and falls back to cargo if needed.

curl -fsSL https://raw.githubusercontent.com/dzmbs/crosswind/main/install.sh | bash

By default, the binary is installed to ~/.local/bin. Override with CROSSWIND_INSTALL_DIR:

CROSSWIND_INSTALL_DIR=/usr/local/bin curl -fsSL https://raw.githubusercontent.com/dzmbs/crosswind/main/install.sh | bash

From source (cargo install)

Requires Rust 1.88 or later.

From Git

cargo install --git https://github.com/dzmbs/crosswind --bin crosswind

From a local checkout

git clone https://github.com/dzmbs/crosswind.git
cd crosswind
cargo install --path .

Pre-built binaries (manual)

Download the latest release tarball for your platform from the releases page.

# Example for macOS arm64
tar xzf crosswind-v0.2.0-macos-aarch64.tar.gz
sudo mv crosswind /usr/local/bin/

Or place it anywhere on your PATH:

mkdir -p ~/.local/bin
mv crosswind ~/.local/bin/

Verify installation

crosswind --version
crosswind --help

Supported platforms

PlatformArchitectureStatus
macOSarm64 (Apple Silicon)Supported
macOSx86_64 (Intel)Supported
Linuxx86_64Supported
Linuxarm64Best-effort
Windowsx86_64Best-effort

"Best-effort" means it should work but is not part of the primary test matrix.

Build from source

cargo build --release
# Binary is at target/release/crosswind