Skip to content

n0-computer/iroh

iroh

A toolkit for building distributed applications

Documentation Crates.io downloads Chat Youtube License: MIT License: Apache 2.0 CI


Features

  • Documents - Authors create and join documents: mutable key-value stores that multiple users read from, write to, and sync with, subscribing to live updates in real time.
  • Blobs - Iroh works with content-addressed blobs of opaque data, which are often the bytes of a file.
  • Networking - At the core of iroh is the ability to connect any two devices, no matter where they are.

Overview

Iroh is a protocol for syncing & moving bytes. Bytes of any size, on any device. At its core, it's a peer-2-peer network built on a magic socket that establishes QUIC connections between peers. Peers request and provide blobs of opaque bytes that are incrementally verified by their BLAKE3 hash during transfer.

Getting Started

Iroh is delivered as a Rust library and a CLI.

Library

Run cargo add iroh, to add iroh to your project.

CLI

Check out https://iroh.computer/docs/install to get started.

The implementation lives in the iroh-cli crate.

Links

License

Copyright 2024 N0, INC.

This project is licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.