Implementation guides

Find the specifications relevant to what you are building. To try the tools first, read Getting started. This guide is non-normative; the linked specifications define the implementation requirements.

Understand the architecture

1. Common model — the relationship between FormRef, Form Package and Snapshot.
2. Portability boundary — what a Form defines and what Hosts or operators decide.
3. Versioning and compatibility — API and Form versions versus implementation releases.

A Form describes service settings and behavior. Accounts, credentials, placement, pricing and backend selection belong to the Host or operating environment.

Work with packages in Go

1. Try package verification and Snapshot construction in Getting started.
2. Read Form Package for declared files and digest calculation.
3. Read Snapshot for reference verification, defaults and order-independent construction.
4. Use the formpackage, snapshot and trust APIs.

These operations verify data. They do not connect to a Host or create resources.

Implement a Host or client

1. Read the Host API overview for discovery and the API structure.
2. Implement the requests, responses, concurrency checks and errors in Host API v1.
3. Read Interface, Binding and Artifact transport for the capabilities you need.
4. Check Standard Services when using external protocols.

Client-specific schemas, state management and import behavior belong to the client. The Host manages backends, credentials, tenant policies and Form activation.

Interpret verification results

1. Read Conformance checks for report scope and checks.
2. Read Conformance for requirement language and claim categories.
3. Read Trust and revocation for caller-supplied trust policy and verification data.

A valid package does not prove public availability or support on a particular Host. Check publication and Host support with their respective owners.

Use OpenTofu

See terraform-provider-takoform for OpenTofu examples, provider schemas, state management and import behavior.

Look up an individual Form

Each publisher provides its own Form settings and examples. This site documents the data formats and API shared by Forms.