Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
96 lines (72 loc) · 2.75 KB

DEVELOPMENT.md

File metadata and controls

96 lines (72 loc) · 2.75 KB
Raw

Quickstart (GitHub, no local install)

  1. Click Code → Create codespace on main.
  2. In the terminal: cargo fmt --all cargo clippy --all -- -D warnings cargo test --all
  3. If you touched the UI: cd ui corepack enable pnpm install --frozen-lockfile pnpm test:e2e

Local Development

This page contains instructions on how to run everything locally.

Build from Source

Requirements:

  • Rust 1.86+
  • Node 24.17.0 (see ui/.nvmrc)

The UI is built with pnpm. The version is pinned in ui/package.json under packageManager, and Corepack (bundled with Node) installs it for you. Run corepack enable once per environment.

Build the agentgateway UI:

cd ui
pnpm install --frozen-lockfile
pnpm build

--frozen-lockfile installs exactly what ui/pnpm-lock.yaml records and fails if it disagrees with package.json. CI, the release build and the Docker images run the same command. pnpm lint and pnpm test:e2e are the checks CI runs, and pnpm dev starts the dev server on http://localhost:19000.

Dependencies are pinned to exact versions. To change one, edit ui/package.json, run pnpm install without --frozen-lockfile, and commit the updated lockfile.

Build the agentgateway binary:

cd ..
export CARGO_NET_GIT_FETCH_WITH_CLI=true
make build

Run the agentgateway binary:

./target/release/agentgateway

Open your browser and navigate to http://localhost:15000/ui to see the agentgateway UI.

Local Development with Tilt (Kubernetes)

For developing against a local Kind cluster with live reloading:

Requirements (in addition to the above):

  • Kind
  • Tilt
  • ctlptl - used to create a Kind cluster with a local registry
  • cross - required for ensuring the Rust backend compiles (or cross-compiles) for Linux
  • Docker (or Podman) — required by both Kind and cross
  • Go 1.22+ (for the controller)

NOTE: On Apple Silicon Macs, Tilt runs the cross build container as linux/amd64 because the default cross image for aarch64-unknown-linux-gnu does not publish a linux/arm64 manifest. This still produces the Linux arm64 dataplane binary used by Kind.

On Apple Silicon Macs, install the Linux x86_64 variant of the repo's active Rust toolchain so cross can run Rust inside that container:

rust_version=$(awk -F'"' '/^channel =/ {print $2}' rust-toolchain.toml)
rustup toolchain install "${rust_version}-x86_64-unknown-linux-gnu" \
   --profile minimal \
   --force-non-host

Create the local Kind cluster and registry if they do not already exist:

ctlptl create cluster kind --name kind-kind --registry=ctlptl-registry

Run:

tilt up