Documentation

Start building with Tetrapus

Guides, references, and architecture for developers, operators, and DevOps.

Quick Start

Full guide
Bash 
docker pull registry.tetrapus.com/tetrapus
docker run -it --rm \
  -e DISPLAY=$DISPLAY \
  -v /tmp/.X11-unix:/tmp/.X11-unix \
  --device /dev/dri \
  registry.tetrapus.com/tetrapus

Getting Started

Quick Start

Docker Deployment

Architecture Overview

SDK Integration

Transport Layer

IoT & Edge Compute

Overview

Getting Started

Client API

Reliability

Command Channel

HFT Sidecar

CLI Tool

Server Pipeline

Adapters

Data Sources & Config

Overview

Schema Reference

Connections

Storage & ClickHouse

Computed Fields

Visual Mapper

Alerts Config

State Machines

Zones

Reality

Overview

Object Types

Link Types

Actions

Expressions

Mutations

Workspace

Overview

Welcome Screen

Menu Bar

Command Palette

Pane Toolbar

Panes & Layout

Layers

Data Sources Sidebar

Sidebar

Bottom Drawer

Modals & Dialogs

Settings

Control Systems

Overview

Command Bus

Widgets

Policy Engine

Simulators

Bus Architecture

Automation & AI

Overview

Action Capture

Pattern Mining

Automation Synthesis

Feedback & Approval

Claude Tools

LLM Agents

Sidebar Panels

Monitoring

Overview

Prometheus Metrics

Alerts & Escalation

Alert Suppression

Health & Diagnostics

Observability Stack

Reporting & Export

Overview

Export Formats

Scheduling & Delivery

Encryption & Signing

Compliance

Access & Security

Overview

Principals & Roles

Permissions

Registry & Profiles

ABAC & Cedar Policies

Markings & Propagation

Audit Trail

Secret Store

Federation & SSO

Overview

SAML 2.0

SAML Admin & API

OIDC Consumer

OIDC Provider

SCIM 2.0

WebAuthn / Passkeys

Smart Cards (PIV/CAC)

Enterprise

Overview

KMS Backends

FIPS 140-3

SIEM Forwarding

Audit Attestation

CMEK / BYOK

Data Residency

Legal Hold

Backup Attestation

JIT Elevation

Compliance Coverage

Multi-Tenancy

Overview

Control Plane

Tenant Gateway

K8s Operator

Billing & Metering

Deploy

Overview

Helm Chart

systemd Units

Air-Gap Install

Admin CLI

Version Control

Overview

Git Engine

Snapshots

Sandboxes

Migration

Every crate has comprehensive #![warn(missing_docs)] rustdoc with architecture diagrams.

cargo doc --workspace --open