Installation
Install the Iroh Command Line Interface (CLI) for MacOS, Linux & Windows.
Iroh is meant be used as a library by importing one of the existing Iroh SDKs, but the CLI provides a great tool for working with iroh, and is a great way to use iroh if your language doesn't have a supported SDK.
Install via bash script
Run this script to get started:
curl -fsSL https://sh.iroh.computer/install.sh | sh
Package Managers
Iroh is available on tea for macOS and Linux. To install, run:
$ curl tea.xyz | sh
# ^^ installs the tea package manager
$ iroh --help
# ^^ tea installs iroh automagically
Docker Containers
Iroh is available as a Docker container. To run the latest version, run:
docker pull n0computer/iroh
We also make supporting binaries like the iroh relay & iroh DNS available on docker hub
NixOS
Iroh is available as a nix flake
Building from Source
Details on how to build from source can be found in the iroh Developer documentation.
Removing Iroh
To completely remove iroh from your system, remove the binary executable and delete the data directory.
By default the iroh CLI persists to a data directory that keeps configuration & a small database. The location of that directory is platform specific:
| Platform | Value | Example |
|---|---|---|
| Linux | $XDG_CONFIG_HOME or $HOME/.config/iroh | /home/alice/.config/iroh |
| macOS | $HOME/Library/Application Support/iroh | /Users/Alice/Library/Application Support/iroh |
| Windows | {FOLDERID_RoamingAppData}/iroh | C:\Users\Alice\AppData\Roaming\iroh |