Skip to content

irohad CLI

irohad starts an Iroha peer daemon. The same crate also builds track-specific daemon aliases:

  • iroha3d for the Iroha 3 build line
  • iroha2d for the Iroha 2 build line

Use irohad or iroha3d for current Iroha 3 examples unless a deployment script intentionally pins the Iroha 2 profile.

shell
irohad --config path/to/config.toml

--config

  • Type: File Path
  • Alias: -c

Path to the configuration file.

shell
irohad --config path/to/iroha.toml

--genesis-manifest-json

  • Type: File Path

Optional path to a genesis manifest JSON file. Use this when the deployment validates startup against a manifest generated by Kagami.

shell
irohad --config path/to/iroha.toml --genesis-manifest-json path/to/genesis.manifest.json

--trace-config

Enables trace logs of configuration reading and parsing. Might be useful for configuration troubleshooting.

  • Type: flag
  • ENV: TRACE_CONFIG
shell
irohad --trace-config

--terminal-colors

  • Type: Boolean, either --terminal-colors=false or --terminal-colors=true
  • Default: auto-detect terminal support
  • ENV: TERMINAL_COLORS

Whether to enable ANSI-colored output or not.

By default, Iroha determines whether the terminal supports colored output or not.

To explicitly disable colours:

shell
irohad --terminal-colors=false

# or via env

export TERMINAL_COLORS=false
irohad

--language

  • Type: String

Override the system language used for daemon messages.

shell
irohad --language en-US

--sora

  • Type: flag
  • ENV: IROHA_SORA_PROFILE

Enable the Sora Nexus feature profile for SoraFS, the SoraNet handshake, and multi-lane consensus flows.

shell
irohad --config path/to/iroha.toml --sora

--fastpq-execution-mode

  • Type: auto, cpu, or gpu

Override FASTPQ prover execution mode.

shell
irohad --fastpq-execution-mode auto

--fastpq-poseidon-mode

  • Type: auto, cpu, or gpu

Override FASTPQ Poseidon pipeline mode.

shell
irohad --fastpq-poseidon-mode cpu

--fastpq-device-class

  • Type: String

Override the FASTPQ telemetry device-class label.

shell
irohad --fastpq-device-class apple-m4

--fastpq-chip-family

  • Type: String

Override the FASTPQ telemetry chip-family label.

shell
irohad --fastpq-chip-family m4

--fastpq-gpu-kind

  • Type: String

Override the FASTPQ telemetry GPU-kind label.

shell
irohad --fastpq-gpu-kind integrated