User Guide

Choose the route that matches your responsibility. These pages prefer concrete commands and decision points over API internals.

For data analysts

Start with Getting Started when you have received access to an AHRI TRE and need to select a profile, authenticate, open a Session, discover governed Studies and assets, and run basic Datastore commands. CLI How-To and the HDSS workflow provide end-to-end examples.

Analysts should not need Docker, PostgreSQL administrator credentials, direct Lake access, or the development environment. Ask the TRE operator for the installed Client bootstrap, admitted Runtime login, profile names, and Study access.

For system integrators

Use the System Integrator Guide to distinguish repository testing, non-production Local TRE evaluation, and the controls that an independently designed staging or production environment must supply.

For developers

Use the Developer Guide for the VS Code container, ordinary Rust validation, disposable Integration fixtures, Local TRE profiles, and the replacement-environment migration boundary.

Installed package workflows

Start with Installation when you have received an AHRI TRE runtime package and need to install the CLI, daemon, runtime libraries, and generated Client bootstrap.

Use Getting Started when you have an installed AHRI TRE CLI package and need to select an operator-published profile, use an authorized Session, and run basic Datastore commands.

Use CLI How-To when you need deeper command examples from a checkout, local Managed-runtime diagnostics, or authenticated protocol operations against a configured datastore.

Use Importing A REDCap Project when you need to bring a complete REDCap project into an existing study and domain, including source artifact preservation, dictionary registration, and form-dataset materialization.

Use Creating Datastores when you need to provision a new datastore identity and its underlying metadata database, DuckLake catalog database, and lake directory for examples or validation.

For reference tables, see Configuration And Secrets. For workflow output details, see Example Workflows. For package maintainers, see the Developer Installation Package Guide.