How-to guides

How-to pages are recipes. Each one assumes you know what you are trying to do and need the steps to do it. Every page follows the same skeleton:

1. Prerequisites. What must be installed and what state your project must be in.
2. The task. The minimum sequence of commands or code to accomplish the goal.
3. Verification. How to confirm the task succeeded.
4. Common mistakes. Failure modes and how to recognise them.
5. See also. Adjacent how-tos, the relevant reference page, and the explanation page that covers the underlying model.

If you want to understand why a step works, follow the link to the explanation quadrant. If you want a complete walk-through with no prior context, start with a tutorial.

Index

Setup

• Install the CLI, Rust, TypeScript, Python

Schemas and migrations

• Define a schema (CLI, TypeScript, Python, Rust)
• Build a migration
• Apply field transforms
• Use lenses, protolenses, dependent optics
• Write lenses in the lens DSL
• Build a custom protocol

Working with data

• Query instances
• Convert data between formats
• Round-trip with format preservation
• Parse full ASTs
• Decorate an abstract schema

Version control

• Init and commit, branch and merge, data versioning, git bridge

Translation and integration

• Translate across protocols

CI

• Breaking-change gate, GitHub Actions, pre-commit hooks