Skip to main content

How-To Guides

Task recipes for people who already know the concepts.

Each guide answers one “how do I…?” question and assumes you already know the relevant concepts. If you are new to RECAP, start with Getting Started instead; it teaches the same operations in order, with explanation.

Set Up Access

Run a RECAP server, or connect to one that already exists. Set Up a RECAP Server covers deployment and configuration; Authenticate a Remote Client covers credentials. Neither is needed for local SQLite work.

Create Templates

Define the shapes your experiment reuses: resource templates, process templates, nested hierarchies, and how to revise them safely once they are in use.

Create and Edit Instances

Record real experimental data against those definitions: process runs, runtime children, property edits, lifecycle transitions, and safe retries.

Query Experiments

Find and filter records, control which relationships are loaded, and trace provenance from a result back to its inputs.

Operate and Troubleshoot

Diagnose failures using request IDs, and keep queries efficient as data grows.


For definitions of terms used throughout these guides, see the Glossary. For exact signatures, see the API Reference.