AxorumAxorum
Reading register

Getting started

Installation

Axorum builds from source. Binary distribution and published crates are in progress; until they land, cloning the workspace and building it is the supported path.


Requirements

A recent stable Rust toolchain and a C toolchain for the cryptographic dependencies. Nothing else: the workspace has no database, no message broker, and no external service to stand up.

shell
1rustc --version
2cargo --version
3

Build from source

shell
1git clone https://github.com/AxorumHQ/axorum.git
2cd axorum
3cargo build --release
4

The workspace is large — twenty-five crates — and a cold release build takes a while. It builds clean: the project holds a zero-clippy-warning, zero-lint-suppression standard, and unsafe_code is forbidden across every crate.

What you get

Several binaries, of which two matter for a first look.

axorum-serve is the network service: the agent plane, where intents are submitted and ledger state is read, and a token-gated administrative plane, where policies are authored, reviewed, and activated. It runs standalone against an in-process ledger, which is the right way to start.

axorum-clusterd is the replicated node: the same ledger behind a Viewstamped Replication consensus group, with a checksummed write-ahead journal and periodic snapshots. Standalone mode is byte-compatible with it, so nothing you learn against axorum-serve is invalidated when you move to a cluster.

There is also axorum-demo, a byte-reproducible eight-beat transcript that drives the entire stack end to end — DSL authoring, delegation, a purchase, a duty, a breach, a reparation — narrated in plain compliance English. It is the fastest way to see the whole model move.

shell
1cargo run --release --bin axorum-demo
2

Next

Work through the quickstart to activate a policy and submit an intent against a running node.