Skip to content

Latest commit

 

History

4,831 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Amaru

A Cardano node client written in Rust.

Licence Twitter/X Discord


Image Image Image Image Image

Getting Started

Amaru is still in an exploratory phase. Our development strategy favors early integration of components, so that progress is instantly visible, even though features might be limited or incomplete.

Installing

Manual installation: pre-compiled executables

You can install Amaru "manually" by downloading an archive with pre-compiled (statically linked) executables for all usual platforms (Linux, macOS & Windows). The archives come with shell completions scripts.

See either:

Alternatively, Amaru also comes pre-packaged for a few platforms.

Image Docker Image

docker pull ghcr.io/pragma-org/amaru:v10.11.20260827

Important

The tag :latest refers to the latest nightly build; not the latest release.

Image Homebrew (macOS & Linux)

brew tap pragma-org/amaru https://github.com/pragma-org/amaru && brew trust --tap pragma-org/amaru
brew install amaru

Image Nix (macOS & Linux)

nix profile install --no-write-lock-file github:pragma-org/amaru#amaru

Image Debian

VERSION=10.11.20260827 ARCH=x86_64; curl -fsSL -o amaru-$VERSION-linux-$ARCH.deb "https://github.com/pragma-org/amaru/releases/download/v$VERSION/amaru-$VERSION-linux-$ARCH.deb"
VERSION=10.11.20260827 ARCH=x86_64; sudo apt install ./amaru-$VERSION-linux-$ARCH.deb

Also available for ARCH=aarch64. The Debian package installs a systemd unit and reads overrides from /etc/default/amaru.

Image RPM

VERSION=10.11.20260827 ARCH=x86_64; curl -fsSL -o amaru-$VERSION-linux-$ARCH.rpm "https://github.com/pragma-org/amaru/releases/download/v$VERSION/amaru-$VERSION-linux-$ARCH.rpm"
VERSION=10.11.20260827 ARCH=x86_64; sudo dnf install ./amaru-$VERSION-linux-$ARCH.rpm

Also available for ARCH=aarch64. The RPM package installs a systemd unit and reads overrides from /etc/sysconfig/amaru.

Building from sources

cargo build --release

Tip

Prefer not to install Rust locally? We provide a Docker-based build and run path. See docker/README.md for instructions on using Docker instead.

Running

  1. (First time) Bootstrap the node:
amaru node bootstrap --network=mainnet
  1. (Optional) Setup observability backends:
docker compose -f monitoring/docker-compose.yml up -d
  1. Run Amaru:
amaru node run --network=mainnet

Tip

To ensure logs are forwarded to an OpenTelemetry backend, set AMARU_WITH_OPEN_TELEMETRY=true:

amaru --with-open-telemetry node run --network=mainnet

See also amaru node run --help for more options.

Monitoring

See monitoring/README.md.


Roadmap | 📐 Contributing | 📰 ChangeLog

About

A fully open source node client for Cardano, written in Rust

Topics

Resources

Contributing

Stars

114 stars

Watchers

6 watching

Forks

Releases

Packages

Used by

Contributors

Languages