Documentation

Everything Surp does, written from the source.

Each page in this site is generated from the repository's own Markdown (README.md, docs/*.md, SECURITY.md, CHANGELOG.md) and reads the verified API names and CLI flags directly. Nothing in here is invented.

Start here

Getting Started

Install, build, and run your first round-trip.

Documentation home

This page.

Examples

Worked examples from the repo's examples/ tree.

Architecture

Architecture overview

Hand-drawn diagrams of the workspace and codec.

v1 binary spec

The block-framed v1 binary format, byte by byte.

RFC-001 (CTN / CBF / CQL)

CTN, CBF, and the baseline CQL path engine.

Reference

Rust API

Encoder, Decoder, Value, SurpValue, derive macros.

Python API

dumps/loads, Encoder, SurpDecoder, surp.model.

CLI reference

Every surp subcommand and flag.

MCP server

Model Context Protocol server surface.

Project

Changelog

Semantic-versioned release history.

Community

Where conversations and contributions happen.

Help

Common questions and troubleshooting.

Security & risks

SECURITY.md and DESIGN_RISKS.md, side by side.