Add Binaries guide #480

0x009922 · 2024-03-21T09:40:45Z

No description provided.

Signed-off-by: Dmitry Balashov <[email protected]>

vercel · 2024-03-21T09:40:49Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
iroha-2-docs	❌ Failed (Inspect)			Jul 11, 2024 5:11am

0x009922 · 2024-03-21T09:46:22Z

src/guide/misc-using-binaries.md

+When working with Iroha, certain components (e.g., `iroha_client_cli`) are delivered as binary files that could not only be built and installed as standalone tools locally, but also come prepackaged with any of the official versions of Iroha 2 (`dev`, `lts`, or `stable`).
+
+::: info
+
+For details on the differences between the versions of Iroha 2, see [Get Started > Install Iroha 2: Choose Version](guide/get-started/install.md#choose-version).
+
+:::


I would say, this all doesn't make sense and seem extra.

Suggested change

When working with Iroha, certain components (e.g., `iroha_client_cli`) are delivered as binary files that could not only be built and installed as standalone tools locally, but also come prepackaged with any of the official versions of Iroha 2 (`dev`, `lts`, or `stable`).

::: info

For details on the differences between the versions of Iroha 2, see [Get Started > Install Iroha 2: Choose Version](guide/get-started/install.md#choose-version).

:::

0x009922 · 2024-03-21T09:47:10Z

src/guide/misc-using-binaries.md

+The Iroha 2 project provides the following binary executables:
+
+- [`iroha`](https://github.com/hyperledger/iroha/tree/iroha2-dev/cli) — the main Iroha CLI that is used to instantiate a peer and bootstrap an Iroha-based network.
+- [`iroha_client_cli`](https://github.com/hyperledger/iroha/tree/iroha2-dev/client_cli) — Iroha Client CLI that is used to interact with the Iroha Peers Web API (Q: certain operations within Torii? (i.e., submmitting transactions with ISI, query requests)), and serves as a reference for using the features of the [iroha_client](https://github.com/hyperledger/iroha/tree/iroha2-dev/client) crate.


Suggested change

- [`iroha_client_cli`](https://github.com/hyperledger/iroha/tree/iroha2-dev/client_cli) — Iroha Client CLI that is used to interact with the Iroha Peers Web API (Q: certain operations within Torii? (i.e., submmitting transactions with ISI, query requests)), and serves as a reference for using the features of the [iroha_client](https://github.com/hyperledger/iroha/tree/iroha2-dev/client) crate.

- [`iroha_client_cli`](https://github.com/hyperledger/iroha/tree/iroha2-dev/client_cli) — Iroha Client CLI that is used to interact with an Iroha peer (Q: certain operations within Torii? (i.e., submmitting transactions with ISI, query requests)).

0x009922 · 2024-03-21T09:47:30Z

src/guide/misc-using-binaries.md

+
+The Iroha 2 project provides the following binary executables:
+
+- [`iroha`](https://github.com/hyperledger/iroha/tree/iroha2-dev/cli) — the main Iroha CLI that is used to instantiate a peer and bootstrap an Iroha-based network.


Suggested change

- [`iroha`](https://github.com/hyperledger/iroha/tree/iroha2-dev/cli) — the main Iroha CLI that is used to instantiate a peer and bootstrap an Iroha-based network.

- [`iroha`](https://github.com/hyperledger/iroha/tree/iroha2-dev/cli) — the main Iroha CLI that is used to start a peer.

0x009922 · 2024-03-21T09:48:29Z

src/guide/misc-using-binaries.md

+First, install the following Docker prerequisites:
+
+- [Docker](https://docs.docker.com/get-docker/)
+- [Docker Compose](https://docs.docker.com/compose/install/)


In this specific guide, there is no need for Docker Compose.

Suggested change

- [Docker Compose](https://docs.docker.com/compose/install/)

0x009922 · 2024-03-21T09:49:08Z

src/guide/misc-using-binaries.md

+::: info
+
+Listed examples only reference the `dev` versions of the Docker images.
+
+For a list of all available Docker images for Iroha 2, see the [Iroha 2 Docker Hub](https://hub.docker.com/r/hyperledger/iroha2) page.
+
+:::


Let's omit this for now. There will be no dev/stable/lts channels in future.

Suggested change

::: info

Listed examples only reference the `dev` versions of the Docker images.

For a list of all available Docker images for Iroha 2, see the [Iroha 2 Docker Hub](https://hub.docker.com/r/hyperledger/iroha2) page.

:::

0x009922 · 2024-03-21T09:52:39Z

src/guide/misc-using-binaries.md

+
+::: tip
+
+For more details on `cargo install` and its `[options]`, see [The Cargo Book > cargo install](https://doc.rust-lang.org/cargo/commands/cargo-install.html).


Suggested change

For more details on `cargo install` and its `[options]`, see [The Cargo Book > cargo install](https://doc.rust-lang.org/cargo/commands/cargo-install.html).

For more details on `cargo install` and its `[options]`, see [The Cargo Book > `cargo install`](https://doc.rust-lang.org/cargo/commands/cargo-install.html).

0x009922 · 2024-03-21T09:53:12Z

src/guide/misc-using-binaries.md

+
+### Running from Cloned GitHub Repository {#source-run}
+
+First, clone the [hyperledger / iroha](https://github.com/hyperledger/iroha.git) GitHub repository, then checkout the required branch (`dev`, `lts`, or `stable`):


It is usually written without spaces. (I mean, any repo on GitHub)

Suggested change

First, clone the [hyperledger / iroha](https://github.com/hyperledger/iroha.git) GitHub repository, then checkout the required branch (`dev`, `lts`, or `stable`):

First, clone the [hyperledger/iroha](https://github.com/hyperledger/iroha.git) GitHub repository:

I think for now we need to mention the branch checkout (it's part of the code below anyway)

0x009922 · 2024-03-21T09:54:24Z

src/guide/misc-using-binaries.md

+::: code-group
+
+```shell [Command structure]
+cargo run [options] [binary name] -- [arguments for the binary]


Suggested change

cargo run [options] [binary name] -- [arguments for the binary]

cargo run [options] --bin [binary name] -- [arguments for the binary]

0x009922 · 2024-03-21T09:55:12Z

src/guide/misc-using-binaries.md

+```shell [Iroha]
+cargo run -p iroha --release -- --help
+```
+
+```shell [Client CLI]
+cargo run -p iroha_client_cli --release -- --help
+```
+
+```shell [Kagami]
+cargo run -p kagami --release -- --help
+```


Suggested change

```shell [Iroha]

cargo run -p iroha --release -- --help

```

```shell [Client CLI]

cargo run -p iroha_client_cli --release -- --help

```

```shell [Kagami]

cargo run -p kagami --release -- --help

```

```shell [Iroha]

cargo run --release --bin iroha -- --help

```

```shell [Client CLI]

cargo run --release --bin iroha_client_cli -- --help

```

```shell [Kagami]

cargo run --release --bin kagami -- --help

```

0x009922 · 2024-03-21T09:55:58Z

src/guide/misc-using-binaries.md

+Q:
+1. Бинарниками считаются только `iroha`, `iroha_client_cli` & `kagami`?
+   Крейты отсюда -- https://github.com/hyperledger/iroha/blob/iroha2-dev/README.md#integration -- нельзя use from source repo? (В Докере их точно нет раздельно)


There are some other binaries too, but let's stick to these three for now.

0x009922 · 2024-03-21T09:59:54Z

Also, why Vercel fails:

(!) Found dead link ./guide/get-started/install in file guide/misc-using-binaries.md
(!) Found dead link ./guide/security/generating-cryptographic-keys in file guide/misc-using-binaries.md
(!) Found dead link ./guide/configure/genesis in file guide/misc-using-binaries.md
(!) Found dead link ./guide/configure/peer-configuration in file guide/misc-using-binaries.md
(!) Found dead link ./guide/configure/client-configuration in file guide/misc-using-binaries.md

WRRicht3r · 2024-03-21T10:08:44Z

src/guide/misc-using-binaries.md

@@ -0,0 +1,173 @@
+# Working with Iroha Binaries
+
+When working with Iroha, certain components (e.g., `iroha_client_cli`) are delivered as binary files that could not only be built and installed as standalone tools locally, but also come prepackaged with any of the official versions of Iroha 2 (`dev`, `lts`, or `stable`).


Suggested change

When working with Iroha, certain components (e.g., `iroha_client_cli`) are delivered as binary files that could not only be built and installed as standalone tools locally, but also come prepackaged with any of the official versions of Iroha 2 (`dev`, `lts`, or `stable`).

When working with Iroha, certain components (e.g., `iroha_client_cli`) are delivered as binary files that can be built and installed locally as standalone tools and come prepackaged with any of the official versions of Iroha 2 (`dev`, `lts`, or `stable`).

Suggested change

When working with Iroha, certain components (e.g., `iroha_client_cli`) are delivered as binary files that could not only be built and installed as standalone tools locally, but also come prepackaged with any of the official versions of Iroha 2 (`dev`, `lts`, or `stable`).

When working with Iroha, certain components (e.g., `iroha_client_cli`) are delivered as binary files that can be built and installed as standalone tools locally, or come prepackaged with any of the official versions of Iroha 2 (`dev`, `lts`, or `stable`).

WRRicht3r · 2024-03-21T10:12:13Z

src/guide/misc-using-binaries.md

+
+:::
+
+The Iroha 2 project provides the following binary executables:


Suggested change

The Iroha 2 project provides the following binary executables:

Iroha 2 provides the following binary executables:

WRRicht3r · 2024-03-21T10:13:13Z

src/guide/misc-using-binaries.md

+
+- [`iroha`](https://github.com/hyperledger/iroha/tree/iroha2-dev/cli) — the main Iroha CLI that is used to instantiate a peer and bootstrap an Iroha-based network.
+- [`iroha_client_cli`](https://github.com/hyperledger/iroha/tree/iroha2-dev/client_cli) — Iroha Client CLI that is used to interact with the Iroha Peers Web API (Q: certain operations within Torii? (i.e., submmitting transactions with ISI, query requests)), and serves as a reference for using the features of the [iroha_client](https://github.com/hyperledger/iroha/tree/iroha2-dev/client) crate.
+- [`kagami`](https://github.com/hyperledger/iroha/tree/iroha2-dev/tools/kagami) — a tool that is used to generate and validate various types of data (e.g., cryptographic keys, genesis blocks, default client and peer configuration files).


Suggested change

- [`kagami`](https://github.com/hyperledger/iroha/tree/iroha2-dev/tools/kagami) — a tool that is used to generate and validate various types of data (e.g., cryptographic keys, genesis blocks, default client and peer configuration files).

- [`kagami`](https://github.com/hyperledger/iroha/tree/iroha2-dev/tools/kagami) — a tool that is used to generate and validate various data types (e.g., cryptographic keys, genesis blocks, default client and peer configuration files).

WRRicht3r · 2024-03-21T10:18:39Z

src/guide/misc-using-binaries.md

+
+## Using the Source GitHub Repository {#source}
+
+To perform any of the actions with the GitHub repository (i.e., [building & installing](#source-install), or [running](#source-run) binaries), the [Rust toolchain](https://www.rust-lang.org/) must first be installed. The toolchain is delivered with the package manager—[Cargo](https://doc.rust-lang.org/cargo/index.html)—that allows for installation of Rust crates from different sources, including GitHub.


Suggested change

To perform any of the actions with the GitHub repository (i.e., [building & installing](#source-install), or [running](#source-run) binaries), the [Rust toolchain](https://www.rust-lang.org/) must first be installed. The toolchain is delivered with the package manager—[Cargo](https://doc.rust-lang.org/cargo/index.html)—that allows for installation of Rust crates from different sources, including GitHub.

To perform any of the actions using the GitHub repository (i.e., [building & installing](#source-install), or [running](#source-run) binaries), the [Rust toolchain](https://www.rust-lang.org/tools/install) must be installed first. The toolchain is delivered with the —[Cargo](https://doc.rust-lang.org/cargo/index.html) package manager— which allows for installing Rust crates from different sources, including GitHub.

Incorporated Dima's suggestion here as well

WRRicht3r · 2024-03-21T10:19:13Z

src/guide/misc-using-binaries.md

+
+To perform any of the actions with the GitHub repository (i.e., [building & installing](#source-install), or [running](#source-run) binaries), the [Rust toolchain](https://www.rust-lang.org/) must first be installed. The toolchain is delivered with the package manager—[Cargo](https://doc.rust-lang.org/cargo/index.html)—that allows for installation of Rust crates from different sources, including GitHub.
+
+The recommended way to install the Rust toolchain is through a Rust installer and version management tool—[Rustup](https://rust-lang.github.io/rustup/) (See also: [Install Rust](https://www.rust-lang.org/tools/install))—by executing the following command in your terminal:


Suggested change

The recommended way to install the Rust toolchain is through a Rust installer and version management tool—[Rustup](https://rust-lang.github.io/rustup/) (See also: [Install Rust](https://www.rust-lang.org/tools/install))—by executing the following command in your terminal:

The recommended way to install the Rust toolchain is through the Rust installer and version management tool—[Rustup](https://rust-lang.github.io/rustup/) (See also: [Install Rust](https://www.rust-lang.org/tools/install))—by executing the following command in your terminal:

WRRicht3r · 2024-03-21T10:19:44Z

src/guide/misc-using-binaries.md

+
+Depending on the operating system that you are using or other limitations, you may want to opt for a different installation method.
+
+For all available installation methods, see the [Rust Forge: Other Rust Installation Methods](https://forge.rust-lang.org/infra/other-installation-methods.html) article.


Suggested change

For all available installation methods, see the [Rust Forge: Other Rust Installation Methods](https://forge.rust-lang.org/infra/other-installation-methods.html) article.

For all available installation methods, see this [Rust Forge: Other Rust Installation Methods](https://forge.rust-lang.org/infra/other-installation-methods.html) article.

outoftardis · 2024-04-04T08:25:58Z

src/guide/misc-using-binaries.md

@@ -0,0 +1,173 @@
+# Working with Iroha Binaries
+
+When working with Iroha, certain components (e.g., `iroha_client_cli`) are delivered as binary files that could not only be built and installed as standalone tools locally, but also come prepackaged with any of the official versions of Iroha 2 (`dev`, `lts`, or `stable`).


Suggested change

When working with Iroha, certain components (e.g., `iroha_client_cli`) are delivered as binary files that could not only be built and installed as standalone tools locally, but also come prepackaged with any of the official versions of Iroha 2 (`dev`, `lts`, or `stable`).

When working with Iroha, certain components (e.g., `iroha_client_cli`) are delivered as binary files that can be built and installed as standalone tools locally, or come prepackaged with any of the official versions of Iroha 2 (`dev`, `lts`, or `stable`).

outoftardis · 2024-04-04T08:31:06Z

src/guide/misc-using-binaries.md

+
+To perform any of the actions with the GitHub repository (i.e., [building & installing](#source-install), or [running](#source-run) binaries), the [Rust toolchain](https://www.rust-lang.org/) must first be installed. The toolchain is delivered with the package manager—[Cargo](https://doc.rust-lang.org/cargo/index.html)—that allows for installation of Rust crates from different sources, including GitHub.
+
+The recommended way to install the Rust toolchain is through a Rust installer and version management tool—[Rustup](https://rust-lang.github.io/rustup/) (See also: [Install Rust](https://www.rust-lang.org/tools/install))—by executing the following command in your terminal:


don't we already have the instructions about rust/rustup in the installation guide?

outoftardis · 2024-04-04T08:32:56Z

src/guide/misc-using-binaries.md

+
+### Running from Cloned GitHub Repository {#source-run}
+
+First, clone the [hyperledger / iroha](https://github.com/hyperledger/iroha.git) GitHub repository, then checkout the required branch (`dev`, `lts`, or `stable`):


I think for now we need to mention the branch checkout (it's part of the code below anyway)

outoftardis · 2024-04-04T08:33:33Z

src/guide/misc-using-binaries.md

+
+::: tip
+
+For more details on `cargo run` and its `[options]`, see [The Cargo Book > cargo run](https://doc.rust-lang.org/cargo/commands/cargo-run.html).


Suggested change

For more details on `cargo run` and its `[options]`, see [The Cargo Book > cargo run](https://doc.rust-lang.org/cargo/commands/cargo-run.html).

For more details on `cargo run` and its `[options]`, see [The Cargo Book > `cargo run`](https://doc.rust-lang.org/cargo/commands/cargo-run.html).

Signed-off-by: yamkovoy <[email protected]>

nxsaken · 2024-07-15T07:40:53Z

src/guide/get-started/binaries.md

@@ -0,0 +1,143 @@
+# Working with Iroha Binaries
+
+When working with Iroha, certain components (e.g., `iroha_client_cli`) are delivered as binary files that can be built and installed as standalone tools locally, and also come prepackaged with  Iroha 2.


Suggested change

When working with Iroha, certain components (e.g., `iroha_client_cli`) are delivered as binary files that can be built and installed as standalone tools locally, and also come prepackaged with Iroha 2.

When working with Iroha, certain components (e.g., `iroha`) are delivered as binary files that can be built and installed as standalone tools locally, and also come prepackaged with Iroha 2.

This sentence is a bit confusing. It should just say that working with Iroha involves using several binaries, and this is how.

nxsaken · 2024-07-15T07:44:35Z

src/guide/get-started/binaries.md

+
+Iroha 2 provides the following binary executables:
+
+- [`iroha`](https://github.com/hyperledger/iroha/tree/iroha2-dev/cli) — the main Iroha CLI that is used to start a peer.


Suggested change

- [`iroha`](https://github.com/hyperledger/iroha/tree/iroha2-dev/cli) — the main Iroha CLI that is used to start a peer.

- [`irohad`](https://github.com/hyperledger/iroha/tree/main/cli) — the main Iroha CLI that is used to start a peer.

nxsaken · 2024-07-15T07:44:49Z

src/guide/get-started/binaries.md

+Iroha 2 provides the following binary executables:
+
+- [`iroha`](https://github.com/hyperledger/iroha/tree/iroha2-dev/cli) — the main Iroha CLI that is used to start a peer.
+- [`iroha_client_cli`](https://github.com/hyperledger/iroha/tree/iroha2-dev/client_cli) — Iroha Client CLI that is used to interact with an Iroha peer.


Suggested change

- [`iroha_client_cli`](https://github.com/hyperledger/iroha/tree/iroha2-dev/client_cli) — Iroha Client CLI that is used to interact with an Iroha peer.

- [`iroha`](https://github.com/hyperledger/iroha/tree/main/client_cli) — Iroha Client CLI that is used to interact with an Iroha peer.

nxsaken · 2024-07-15T07:45:02Z

src/guide/get-started/binaries.md

+
+- [`iroha`](https://github.com/hyperledger/iroha/tree/iroha2-dev/cli) — the main Iroha CLI that is used to start a peer.
+- [`iroha_client_cli`](https://github.com/hyperledger/iroha/tree/iroha2-dev/client_cli) — Iroha Client CLI that is used to interact with an Iroha peer.
+- [`kagami`](https://github.com/hyperledger/iroha/tree/iroha2-dev/tools/kagami) — a tool that is used to generate and validate various types of data (e.g., cryptographic keys, genesis blocks, default client and peer configuration files).


Suggested change

- [`kagami`](https://github.com/hyperledger/iroha/tree/iroha2-dev/tools/kagami) — a tool that is used to generate and validate various types of data (e.g., cryptographic keys, genesis blocks, default client and peer configuration files).

- [`kagami`](https://github.com/hyperledger/iroha/tree/main/tools/kagami) — a tool that is used to generate and validate various types of data (e.g., cryptographic keys, genesis blocks, default client and peer configuration files).

nxsaken · 2024-07-15T07:56:41Z

src/guide/get-started/binaries.md

+
+:::
+
+Iroha 2 provides the following binary executables:


irohad and kagami are mandatory for running Iroha peers, and together with iroha (one of the ways of interacting with Iroha peers) they are bundled in the Docker image.

There are also the tool binaries: iroha_swarm, kura_inspector, iroha_wasm_builder, iroha_wasm_test_runner, parity_scale_cli. They are not part of the Docker image, and are not required.

nxsaken · 2024-07-15T09:43:40Z

src/guide/get-started/binaries.md

+
+### Installing from Source GitHub Repository {#source-install}
+
+To perform a system-wide installation of an Iroha 2 binary with `cargo install`, execute one of the following commands in your terminal:


Suggested change

To perform a system-wide installation of an Iroha 2 binary with `cargo install`, execute one of the following commands in your terminal:

Iroha binaries may be installed system-wide using `cargo install`:

nxsaken · 2024-07-15T09:48:01Z

src/guide/get-started/binaries.md

+:::
+
+### Running from Cloned GitHub Repository {#source-run}
+


Suggested change

You may want to run the binaries without installing them system-wide. This will involve cloning Iroha's source code and using `cargo run`.

nxsaken · 2024-07-15T10:55:27Z

src/guide/get-started/binaries.md

+```
+
+```shell [Iroha]
+cargo run --release --bin iroha -- --help


Suggested change

cargo run --release --bin iroha -- --help

cargo run --release --bin irohad -- --help

Maybe add a comment that --release will result in better performance due to the project being built in the optimized release mode.

nxsaken · 2024-07-15T10:55:34Z

src/guide/get-started/binaries.md

+```
+
+```shell [Client CLI]
+cargo run --release --bin iroha_client_cli -- --help


Suggested change

cargo run --release --bin iroha_client_cli -- --help

cargo run --release --bin iroha -- --help

nxsaken · 2024-07-15T10:57:11Z

src/guide/get-started/binaries.md

+```shell
+git clone https://github.com/hyperledger/iroha.git <clone-folder>
+cd <clone-folder>
+git checkout iroha2-dev


Suggested change

git checkout iroha2-dev

0x009922 added 2 commits March 21, 2024 18:37

[docs]: add @yamkovoy's edition

707cba2

Signed-off-by: Dmitry Balashov <[email protected]>

[docs]: minimal edits

8a18bf7

Signed-off-by: Dmitry Balashov <[email protected]>

vercel bot had a problem deploying to Preview March 21, 2024 09:41 Failure

0x009922 commented Mar 21, 2024

View reviewed changes

0x009922 assigned yamkovoy Mar 21, 2024

WRRicht3r requested changes Mar 21, 2024

View reviewed changes

outoftardis reviewed Apr 4, 2024

View reviewed changes

0x009922 mentioned this pull request Jun 6, 2024

build(Dockerfile): pin platform to linux/amd64, refactor hyperledger-iroha/iroha#4688

Merged

5 tasks

0x009922 mentioned this pull request Jun 24, 2024

Incorrect Commands for Iroha Client CLI in Documentation #498

Closed

Updated after review

64a3b9c

Signed-off-by: yamkovoy <[email protected]>

vercel bot had a problem deploying to Preview July 11, 2024 05:11 Failure

yamkovoy requested review from WRRicht3r and mversic July 11, 2024 05:12

nxsaken requested changes Jul 15, 2024

View reviewed changes

dmitrivenger assigned a-zorina and unassigned yamkovoy Aug 22, 2024

	- [`iroha_client_cli`](https://github.com/hyperledger/iroha/tree/iroha2-dev/client_cli) — Iroha Client CLI that is used to interact with the Iroha Peers Web API (Q: certain operations within Torii? (i.e., submmitting transactions with ISI, query requests)), and serves as a reference for using the features of the [iroha_client](https://github.com/hyperledger/iroha/tree/iroha2-dev/client) crate.
	- [`iroha_client_cli`](https://github.com/hyperledger/iroha/tree/iroha2-dev/client_cli) — Iroha Client CLI that is used to interact with an Iroha peer (Q: certain operations within Torii? (i.e., submmitting transactions with ISI, query requests)).


		The Iroha 2 project provides the following binary executables:

		- [`iroha`](https://github.com/hyperledger/iroha/tree/iroha2-dev/cli) — the main Iroha CLI that is used to instantiate a peer and bootstrap an Iroha-based network.


		::: tip

		For more details on `cargo install` and its `[options]`, see [The Cargo Book > cargo install](https://doc.rust-lang.org/cargo/commands/cargo-install.html).


		### Running from Cloned GitHub Repository {#source-run}

		First, clone the [hyperledger / iroha](https://github.com/hyperledger/iroha.git) GitHub repository, then checkout the required branch (`dev`, `lts`, or `stable`):

	First, clone the [hyperledger / iroha](https://github.com/hyperledger/iroha.git) GitHub repository, then checkout the required branch (`dev`, `lts`, or `stable`):
	First, clone the [hyperledger/iroha](https://github.com/hyperledger/iroha.git) GitHub repository:

	cargo run [options] [binary name] -- [arguments for the binary]
	cargo run [options] --bin [binary name] -- [arguments for the binary]

		@@ -0,0 +1,173 @@
		# Working with Iroha Binaries

		When working with Iroha, certain components (e.g., `iroha_client_cli`) are delivered as binary files that could not only be built and installed as standalone tools locally, but also come prepackaged with any of the official versions of Iroha 2 (`dev`, `lts`, or `stable`).

	The Iroha 2 project provides the following binary executables:
	Iroha 2 provides the following binary executables:

	- [`kagami`](https://github.com/hyperledger/iroha/tree/iroha2-dev/tools/kagami) — a tool that is used to generate and validate various types of data (e.g., cryptographic keys, genesis blocks, default client and peer configuration files).
	- [`kagami`](https://github.com/hyperledger/iroha/tree/iroha2-dev/tools/kagami) — a tool that is used to generate and validate various data types (e.g., cryptographic keys, genesis blocks, default client and peer configuration files).


		## Using the Source GitHub Repository {#source}

		To perform any of the actions with the GitHub repository (i.e., [building & installing](#source-install), or [running](#source-run) binaries), the [Rust toolchain](https://www.rust-lang.org/) must first be installed. The toolchain is delivered with the package manager—[Cargo](https://doc.rust-lang.org/cargo/index.html)—that allows for installation of Rust crates from different sources, including GitHub.


		To perform any of the actions with the GitHub repository (i.e., [building & installing](#source-install), or [running](#source-run) binaries), the [Rust toolchain](https://www.rust-lang.org/) must first be installed. The toolchain is delivered with the package manager—[Cargo](https://doc.rust-lang.org/cargo/index.html)—that allows for installation of Rust crates from different sources, including GitHub.

		The recommended way to install the Rust toolchain is through a Rust installer and version management tool—[Rustup](https://rust-lang.github.io/rustup/) (See also: [Install Rust](https://www.rust-lang.org/tools/install))—by executing the following command in your terminal:


		Depending on the operating system that you are using or other limitations, you may want to opt for a different installation method.

		For all available installation methods, see the [Rust Forge: Other Rust Installation Methods](https://forge.rust-lang.org/infra/other-installation-methods.html) article.


		::: tip

		For more details on `cargo run` and its `[options]`, see [The Cargo Book > cargo run](https://doc.rust-lang.org/cargo/commands/cargo-run.html).

		@@ -0,0 +1,143 @@
		# Working with Iroha Binaries

		When working with Iroha, certain components (e.g., `iroha_client_cli`) are delivered as binary files that can be built and installed as standalone tools locally, and also come prepackaged with Iroha 2.

	- [`iroha`](https://github.com/hyperledger/iroha/tree/iroha2-dev/cli) — the main Iroha CLI that is used to start a peer.
	- [`irohad`](https://github.com/hyperledger/iroha/tree/main/cli) — the main Iroha CLI that is used to start a peer.


		### Installing from Source GitHub Repository {#source-install}

		To perform a system-wide installation of an Iroha 2 binary with `cargo install`, execute one of the following commands in your terminal:

	To perform a system-wide installation of an Iroha 2 binary with `cargo install`, execute one of the following commands in your terminal:
	Iroha binaries may be installed system-wide using `cargo install`:



	You may want to run the binaries without installing them system-wide. This will involve cloning Iroha's source code and using `cargo run`.

	cargo run --release --bin iroha -- --help
	cargo run --release --bin irohad -- --help

	cargo run --release --bin iroha_client_cli -- --help
	cargo run --release --bin iroha -- --help

Add Binaries guide #480

Are you sure you want to change the base?

Add Binaries guide #480

Conversation

0x009922 commented Mar 21, 2024

vercel bot commented Mar 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0x009922 commented Mar 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vercel bot commented Mar 21, 2024 •

edited

Loading