novafabric.ai/docs

Documentation

Everything from a first capture to running NovaFabric at cluster scale.

New here? Start with Getting started, then Concepts.

Start here

  • NovaFabric REST API Reference

    Status: works today (v0.98.0). Generated from the live nova serve FastAPI route table (src/novafabric/serve/app.py).

  • Architecture

    A contributor's map of the codebase: what the subsystems are, where they live, and which invariants you must not break. For the conceptual model — what…

  • Assurance Cases

    An assurance case is a machine-checkable argument — in the GSN/SACM/CAE tradition — that a system meets a goal, where every claim ultimately rests on se…

  • Benchmarks

    Every number here is reproducible with a command on this page. If you cannot re-run it, treat it as marketing, not measurement — including these.

  • CLI Reference

    Both nova and novafabric refer to the same binary. NovaFabric is a self-hosted, Apache-2.0 command-line toolkit that captures, replays, diffs, and audit…

  • How NovaFabric compares

    An honest comparison, including where NovaFabric loses. If a tool below is a better fit for what you are doing, use it — a wrong recommendation costs yo…

  • Concepts

    This page is the conceptual reference for NovaFabric. It explains the nouns you will meet everywhere else in the docs and on the nova command line — wha…

  • Local Dashboard (nova serve) — User Reference

    Status: Experimental. Read this entire page before relying on the dashboard for anything that matters. Per: ADR-0027, Non-goals First shipped: v0.7

  • Architecture decisions

    <!-- GENERATED FILE — do not edit by hand. Regenerate with: uv run python scripts/gendecisionsindex.py -->

  • Developer Guide

    This guide is for contributors working inside the NovaFabric tree — not end users. It documents how to build, test, and extend the code that produces No…

  • Drift Detection

    nova drift is NovaFabric's offline drift-detection surface (ADR-0147 — see nova drift --help): it computes distribution-shift statistics over samples dr…

  • For researchers

    Using NovaFabric to make a computational result reproducible, reviewable, and citable — and an honest account of what it does not solve.

  • Getting Started with NovaFabric

    NovaFabric turns any command — a training script, an AI agent, a notebook cell runner — into a Run Capsule: a structured, secret-redacted, self-containe…

  • NovaSeal Configuration Reference

    Status: Works today (NovaSeal v0.1+, ADR-0041)

  • NovaSeal Key Management Guide

    Status: Works today (ADR-0041, NovaSeal v0.1+)

  • NovaSeal API Stability Guarantee

    Status: Works today (ADR-0041, NovaSeal v0.12.15+)

  • NovaFabric Operator Guide

    This guide is for HPC system administrators and platform engineers who deploy NovaFabric on shared infrastructure — from a single workstation to a multi…

  • Python API Reference

    NovaFabric is a CLI-first toolkit, but every capability the nova command exposes is also reachable as a typed Python API. This reference documents the p…

  • Release Process

    Follow these steps to cut a NovaFabric release.

  • RFCs

    This directory holds NovaFabric's public requests for comment — the deliberative record for non-trivial changes.

  • Security & Provenance Knowledge Graph (SPKG)

    Status: Experimental (SPKG, ADR-0111)

  • Performance SLO catalog

    Every published NovaFabric performance number lives here, and every number carries exactly one honesty status:

  • Standards and specifications

    What NovaFabric implements, how to verify each claim yourself, and — kept deliberately prominent — what is not claimed.

  • Support policy — versions, windows, and what "supported" means

    This page is the single source of truth for which NovaFabric versions receive fixes, for how long, and what an upgrade promises. SECURITY.md links here;…

  • Trust Surfaces

    Four read-only commands that turn a capsule's trust evidence into something a human can read at a glance: the Merkle proof tree, the trust-attestation r…

  • NovaFabric Tutorials

    Plain-English guides for engineers at every level. Read in any order.

  • NovaFabric User Guide

    This guide is the working reference for the shipped nova command surface: what each command does, how to invoke it, and when to reach for it. It picks u…

  • Warm capture daemon

    This is a focused guide to one of NovaFabric's more intricate pieces. Read it if you run many captures on one node (a fleet, an HPC job array, a CI farm…

Tutorials

  • Capturing at cluster scale — 1,000,000 agents

    - nova capture writes capsules to local disk - nova serve reads them into Postgres on a single server - The lineage graph lives in that Postgres instance

  • NovaFabric feature tour — every capability, hands-on

    By the end of this tour you will have exercised all five NovaFabric primitives — Asset Registry, Run Capsule, Replay, Lineage, and Evidence Bundle — and…

  • How NovaFabric capture works

    - Why every LLM call is really an HTTP request, and where NovaFabric sits in that exchange. - The difference between the requests and aiohttp libraries,…

  • Capturing multi-agent systems

    How NovaFabric captures a multi-agent system depends entirely on whether the agents share one Python process or run as separate processes.

  • NovaFabric vs Langfuse

    Both tools capture LLM traces. This document explains where they overlap, where they differ, and which questions each one is designed to answer.

  • Prove what an agent did, six months later

    ~20 minutes. By the end you will have a signed, portable artifact that a sceptical third party can verify on their own machine — with no access to your…

  • Why NovaFabric? A plain-English guide

    - The one problem NovaFabric exists to solve: AI and agent runs are non-reproducible and leave no durable evidence. - The five primitives — Asset Regist…

Integrations

Operations

  • Air-Gapped / Offline Deployment Guide

    How to install and operate NovaFabric with no internet connectivity — classified networks, HPC enclaves, regulated environments. Labels follow the docs…

  • Backup & Restore Runbook

    How to back up and restore a NovaFabric deployment. The first half documents procedures that work today with standard tools; the second half covers the…

  • Cluster-Scale Migration Guide

    This guide walks through migrating a local-mode NovaFabric installation (SQLite + filesystem) to a cluster-scale deployment (Postgres + Object Capsule S…

  • Dashboard scale gate — thresholds and how to run it

    Status: works today (gate + thresholds shipped with ADR-0199). Per: ADR-0199 — the dashboard's scale contract (bounded queries, keyset cursors, watermar…

  • Data residency — jurisdiction-aware capsule placement

    Status: experimental (ADR-0247, first slice). Placement enforcement over the object capsule store; the cryptographic proof layer (jurisdiction site seal…

  • Encryption at Rest (opt-in envelope encryption)

    This guide covers NovaFabric's optional application-layer envelope encryption for capsule payloads in the object capsule store (ADR-0185).

  • Incident Runbook (on-call)

    Symptom → diagnosis → action, for the operator on call for a NovaFabric deployment (nova server API, nova serve dashboard, or a local install). Labels f…

  • Monitoring & Self-Observability

    This guide covers monitoring NovaFabric's own HTTP apps — the nova server REST API and the nova serve dashboard backend — with the self-observability su…

  • API Rate Limiting & Storage Quotas

    This guide covers protecting a shared nova server deployment from noisy clients: in-process API rate limiting and warn-then-reject storage quotas (ADR-0…

  • Server Administration Guide (multi-user nova server)

    This guide is for the administrator of a shared, multi-user NovaFabric deployment — the nova server REST API (/v0), not the single-operator nova serve d…

  • Server Deployment Guide

    This guide covers five deployment scenarios for NovaFabric v0.7. Each scenario is labelled with its current implementation status per the docs honesty r…

  • Capacity Planning & Sizing Guide

    How to size storage, memory, and CPU for a NovaFabric deployment — from a single laptop to a shared Postgres server. Everything below is labelled per th…

  • Upgrade Guide

    How to upgrade a NovaFabric deployment from one version to the next — local SQLite installs and Postgres server mode — and what is honestly supported wh…

Lineage

  • LineageStore Migration Guide

    The migration kit (nova lineage-store migrate) rebuilds a lineage graph in a target SQLite lineage store. Two sources are supported:

Governance

  • Design partners

    Status: open — 0 of 5 cohort-1 slots filled, 0 of 3 independent sign-offs on the v1.0 spec. If you run real AI or HPC workloads and want a say in a form…

  • Maintainer criteria

    How merge rights are earned, what they commit you to, and how to step back. This page is deliberately explicit: an unwritten path to maintainership is a…

  • The RFC process

    Status: Adopted 2026-05-07 · Applies to: every non-trivial change to NovaFabric

RFCs

  • RFC-NNNN — <Title>

    Status: Draft | Active | Accepted | Rejected | Withdrawn | Superseded Authors: @github-handle, @github-handle Reviewers: @github-handle (maintainer), @g…

  • RFC-0001 — runs partition key vs. tenant idempotency

    Status: Accepted 2026-08-06 — option C, implemented in migration v004 and ADR-0226. Authors: @MSKazemi (filed from the #23 investigation) Reviewers: @MS…