Skip to content

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.

  1. 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.

  2. Install the Rust dev tools. You only need to do this once.

    Terminal window
    make tools
  3. 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
  4. Build the workspace and run the checks every pull request must pass.

    Terminal window
    make build
    make check
Terminal window
make docs-serve # http://localhost:4321, reloads as you edit
make docker-docs # the same, from the dev container

The dev server regenerates the API reference whenever the Rust, TypeScript or Python sources change.