Agentra LabsAgentra Labs DocsPublic Documentation

Get Started

Installation

AgenticReality can be installed through several channels depending on

AgenticReality can be installed through several channels depending on your workflow.

Install Channels

curl -fsSL https://agentralabs.tech/install/reality | bash

The installer auto-detects your platform (macOS x86_64/aarch64, Linux x86_64/aarch64) and installs the areal binary to ~/.local/bin/.

From crates.io

cargo install agentic-reality-cli

This builds from source and installs the areal binary into your Cargo bin directory.

From Source

git clone https://github.com/agentralabs/agentic-reality.git
cd agentic-reality
cargo build --release
cp target/release/areal ~/.local/bin/

npm (Node.js / WASM)

npm install @agenticamem/reality

Provides WASM bindings for Node.js and browser environments.

PyPI (Python)

pip install agentic-reality

Provides Python bindings compiled via maturin.

As a Library Dependency

Add to your Cargo.toml:

[dependencies]
agentic-reality = "0.1.0"

For MCP server integration:

[dependencies]
agentic-reality-mcp = "0.1.0"

Environment Profiles

AgenticReality auto-detects the runtime environment and configures an appropriate profile:

EnvironmentDetectionStakes Default
ProductionNODE_ENV=production, cloud metadataHigh
StagingNODE_ENV=staging, staging hostnamesMedium
DevelopmentNODE_ENV=development, localhostLow
CI/CDCI=true, GitHub Actions, GitLab CILow
SandboxSANDBOX=true, isolated networksTrivial
SimulationSIMULATED=trueTrivial

The profile sets default values for stakes level, environment type, behavioural expectations, and logging verbosity. All defaults can be overridden through the API or CLI.

Verification

After installation, verify everything works:

# Check version
areal --version

# Initialise a workspace
areal workspace init

# Sense the environment
areal workspace sense

# Run a reality check
areal soul init --spawned-by "manual" --purpose "verification"
areal workspace sense
areal coherence check

Expected output for the coherence check:

Coherence: Full
Violations: 0
Contradictions: 0

Platform Support

PlatformArchitectureStatus
macOSx86_64Supported
macOSaarch64 (Apple Silicon)Supported
Linuxx86_64Supported
Linuxaarch64Supported
Windowsx86_64 (WSL)Supported
WindowsNativePlanned

Minimum Requirements

  • Rust 1.70 or later (MSRV) for building from source
  • 10 MB disk space for the binary
  • 10 MB RAM for the base engine
  • No network access required for core functionality

Shell Completions

Generate shell completions for your shell:

areal completions bash > ~/.bash_completion.d/areal
areal completions zsh > ~/.zfunc/_areal
areal completions fish > ~/.config/fish/completions/areal.fish