Skip to content
IRIS

Documentation

Installation

Install Iris on macOS, Linux, or Windows, and choose which release you get, where it goes, and how the installer verifies it.

Install the latest release

Run the installer for your platform. It downloads the latest stable release from GitHub and installs the iris executable.

Show source
curl -fsSL https://iris-lang.com/install.sh | sh

The installers support Linux on x86-64, macOS on Intel and Apple silicon, and 64-bit Windows. By default, they install Iris in ~/.local/bin on macOS and Linux, and in %LOCALAPPDATA%\Iris\bin on Windows.

If that directory isn’t on your PATH, the installer says so but doesn’t change it for you. Getting started shows how to add it.

Choose a release or directory

The installers read these environment variables:

  • IRIS_VERSION — the release tag to install, such as v0.1.5. Defaults to the latest stable release. The installers support v0.1.0 and later; for a v0.0.x release, use the installer from that release’s Git tag.
  • IRIS_INSTALL_DIR — the directory to install Iris in, instead of the default.
  • IRIS_SKIP_ATTESTATION — set to 1 to skip release verification. See Verify releases.

On macOS and Linux, set them for the shell that runs the installer:

Terminal
curl -fsSL https://iris-lang.com/install.sh | IRIS_VERSION=v0.1.5 sh

In PowerShell, set them before running the installer, for example $env:IRIS_VERSION = "v0.1.5".

Verify releases

When the GitHub CLI (gh) with attestation support is installed, the installers verify the downloaded release’s GitHub build-provenance attestation and stop if verification fails. Without it, they display a warning and continue without verification.

Set IRIS_SKIP_ATTESTATION=1 to skip verification explicitly, for example when gh is installed but can’t access attestations. This reduces provenance assurance, and the installer prints a warning. In PowerShell, set $env:IRIS_SKIP_ATTESTATION = "1" before running the installer.

Canary builds

Successful builds of the main branch are published as GitHub prereleases tagged v<version>-dev.<revision>. To test against the canary channel, find the newest published, non-draft prerelease on the releases page and pass its exact tag through IRIS_VERSION. Installations without IRIS_VERSION continue to use GitHub’s latest stable release.

Packaging Iris

Iris keeps its package version separate from source provenance. When building Iris with Cargo, packagers can set IRIS_BUILD_REVISION to a Git revision to include it in the versions that the CLI and language server report.

The value is read at compile time and must contain 7 to 64 hexadecimal characters. A 0.1.5 build with the revision bcea1aafe65e reports:

Terminal
iris --versioniris 0.1.5-dev.bcea1aafe65e

Builds that omit the variable report the package version unchanged.

Iris is in alpha. Commands and APIs may change between releases.