Getting Started

Prerequisites

• Rust nightly toolchain from rust-toolchain.toml
• devenv (Nix-based environment)
• gh (for GitHub workflows)

Setup

devenv shell
install:all

If pnpm-workspace.yaml sets useNodeVersion, devenv shell activates the matching pnpm-managed node/npm/npx/corepack toolchain automatically.

Build and test

cargo build --all-features
cargo test

Common quality checks

lint:clippy
lint:format
verify:docs

Generate a Codama IDL

pina idl --path ./examples/counter_program --output ./codama/idls/counter_program.json

See Codama Workflow for end-to-end generation and external-project usage.

Build this documentation

docs:build

The generated site is written to docs/book/.