Development setup
Authfil isn’t published yet, so for now getting started means setting up a development environment. Everything runs through make, and make help lists the targets.
Set up
Section titled “Set up”-
Install Rust 1.85 or newer.
Adapter work also needs that adapter’s toolchain: Node.js (LTS), or Python 3.10+ with uv, or Go, or a JDK.
-
Install the Rust dev tools. You only need to do this once.
Terminal window make tools -
Install the git hooks. They run fmt and clippy before each commit, check your commit messages, and run fmt, clippy and cargo-deny before each push.
Terminal window make hooks -
Build the workspace and run the checks every pull request must pass.
Terminal window make buildmake check
The dev image has the Rust, Node and Python toolchains, so you only need Docker.
-
Open a shell with the repository mounted at
/workspace.Terminal window make docker-shell -
Run the pull request checks in the container.
Terminal window make docker-check
Run the docs locally
Section titled “Run the docs locally”make docs-serve # http://localhost:4321, reloads as you editmake docker-docs # the same, from the dev containerThe dev server regenerates the API reference whenever the Rust, TypeScript or Python sources change.
Next steps
Section titled “Next steps”- Find your way around with the directory conventions.
- Read the architecture overview.
- Check the roadmap to see which phase we’re in.
- Read how to contribute.
