| Platform | Architectures |
|---|---|
| macOS | arm64 |
| Linux | x86_64, aarch64 (glibc and musl), armv7 |
| Windows | x86_64, aarch64 |
| Android | aarch64, armv7 |
- API reference: JavaScript API docs
- Example app: hello-iroh-ffi, a console reader for the cross-platform dot demo
- All languages: platform support matrix
@number0/iroh and shipped from iroh-ffi. They’re built with napi-rs, so the package distributes prebuilt native binaries. No Rust toolchain or local compilation is needed.
Install
- macOS:
arm64(no Intel build) - Linux:
x86_64andaarch64(glibc + musl),armv7(gnueabihf + musleabihf) - Windows:
x86_64andaarch64 - Android:
aarch64andarmv7
Hello, iroh
Endpoint.bind applies the n0 preset (public discovery + default relays) by default. Pass an EndpointOptions object to override the preset, supply a fixed secret key, or set ALPNs.
A two-peer echo
A minimal sender/receiver pair over a bidirectional stream:Next steps
Connect two endpoints
Walkthrough of endpoints, tickets, and ALPNs with code samples in every language.
hello-iroh-ffi example app
A headless Node peer for the cross-platform dot demo. It speaks the same wire format as the Swift and Kotlin apps and prints received positions to the console.
JavaScript API reference
Generated TypeDoc reference for
@number0/iroh.iroh-ffi on GitHub
Source, examples, and issue tracker for the JavaScript (and other-language) bindings.