Autonomi Documentation

Welcome to the Autonomi documentation! This guide will help you get started with using the Autonomi network client.

What is Autonomi?

Autonomi is a decentralised data and communications platform designed to provide complete privacy, security, and freedom by distributing data across a peer-to-peer network, rather than relying on centralised servers. Through end-to-end encryption, self-authentication, and the allocation of storage and bandwidth from users’ own devices, it seeks to create an autonomous, self-sustaining system where data ownership remains firmly in the hands of individuals rather than corporations.

Quick Links

Installation Guide
Core Concepts:
Data Types - Understanding the fundamental data structures
Client Modes - Different operational modes of the client
Data Storage - How data is stored and retrieved
Local Network Setup - Setting up a local development environment

API References

Autonomi Client - Core client library for network operations
Ant Node - Node implementation for network participation
BLS Threshold Crypto - Threshold cryptography implementation
Self Encryption - Content-based encryption library
Developer Resources:

Language Support

Autonomi provides client libraries for multiple languages:

Node.jsPythonRust

import { Client } from 'autonomi';

const client = new Client();
await client.connect();

from autonomi import Client

client = Client()
await client.connect()

use autonomi::Client;

let client = Client::new()?;

Building from Source

Python (using Maturin & uv)Node.jsRust

# Install build dependencies
curl -LsSf <https://astral.sh/uv/install.sh> | sh
uv pip install maturin

# Clone the repository
git clone https://github.com/dirvine/autonomi.git
cd autonomi

# Create and activate virtual environment
uv venv
source .venv/bin/activate  # Unix
# or
.venv\Scripts\activate     # Windows

# Build and install the package
cd python
maturin develop

# Install dependencies
uv pip install -r requirements.txt

# Install build dependencies
npm install -g node-gyp

# Clone the repository
git clone https://github.com/dirvine/autonomi.git
cd autonomi

# Build the Node.js bindings
cd nodejs
npm install
npm run build

# Link for local development
npm link

# Clone the repository
git clone <https://github.com/dirvine/autonomi.git>
cd autonomi

# Build the project
cargo build --release

# Run tests
cargo test --all-features

# Install locally
cargo install --path .

Contributing

We welcome contributions! Here's how you can help:

Fork the repository
Create a feature branch
Make your changes
Submit a pull request

For more details, see our Contributing Guide.