Skip to content

Install Iroha 3

This page covers the current installation workflow for the Iroha 3 toolchain and binaries using the upstream hyperledger-iroha/iroha workspace.

1. Prerequisites

Install these first:

  • rustup, so the pinned rust-toolchain.toml toolchain (1.93.1) is installed automatically
  • git
  • optionally, Docker and Docker Compose for the local multi-peer quickstart

2. Clone the Workspace

bash
git clone --branch i23-features https://github.com/hyperledger-iroha/iroha.git
cd iroha

3. Build the Workspace

Build everything:

bash
cargo build --workspace

For a smaller operator-focused build, compile just the main binaries:

bash
cargo build --release -p irohad -p iroha_cli -p iroha_kagami

The resulting binaries are written to target/debug/ or target/release/.

4. Verify the Installed Tools

bash
cargo run --bin irohad -- --help
cargo run --bin iroha -- --help
cargo run --bin kagami -- --help

The three binaries you will usually use are:

  • irohad for the peer daemon
  • iroha for CLI access to Torii and operator endpoints
  • kagami for keys, genesis manifests, and localnet profiles

5. Optional Localnet and Docker Path

The current source-backed localnet flow is generated by Kagami. It writes peer configs, genesis artifacts, client config, helper scripts, and an optional Compose file that matches the checked-out code:

  • kagami localnet for native local peer scripts
  • kagami docker for Docker Compose generated from a localnet directory

Continue with Launch Iroha 3.