Aranya Documentation An overview of the Aranya project

Getting Started with Aranya

If this is your first time working with Aranya, we recommend reading through our Core Concepts for an overview of core aranya concepts and terminology before attempting this getting started guide.

Aranya can be integrated using the client APIs which are available in both Rust and C. The step-by-step tutorial has a detailed explanation with example code on how to set up an Aranya instance and use it to create a team with multiple devices that exchange messages over an Aranya Quic Channel.

An example application has also been built to perform each of the steps from the tutorial automatically. For information on running the app in each of the supported languages (C or Rust), see example app.

Deployment Ecosystem

The Aranya platform is hardware and software agnostic and is designed to be built for a wide variety of platforms. The software is link-agnostic, meaning it could work with any transport protocol over trusted (single) or mixed (multiple) networks.

Designed for Embedded Device Support

  • Lightweight platform: <1.5 MB Binary and <1.5 MB RAM

  • 100% built in Rust, a safety-first, high-level programming language

Supported Platforms

Platforms where Aranya was built/tested in CICD:

  • linux/arm
  • linux/arm64
  • linux/amd64

Platforms where Aranya was built/tested in development:

  • macos/arm64