Skip to content

Local Development

If you want to work on ado-aw itself, a local Rust-based development setup is enough for most compiler and documentation tasks.

Prerequisites

Rust 1.94.0 or later (the project uses the Rust 2024 edition)
Git
An editor of your choice

Install or update Rust:

rustup toolchain install stable
rustup default stable
rustc --version  # must be 1.94.0 or later

Build from source

Navigate to the repository root:
Terminal window
```
cd /path/to/ado-aw
```
Build the project:
Terminal window
```
cargo build
```
For an optimized release build:
Terminal window
```
cargo build --release
```

Run the test suite

Use the standard Rust workflow while developing:

cargo test
cargo clippy

These commands help catch regressions and style issues before you commit changes.

Test compilation locally

Compile an example or your own agent file:
Terminal window
```
cargo run -- compile path/to/agent.md
```
Verify the generated YAML matches the source definition:
Terminal window
```
cargo run -- check path/to/agent.lock.yml
```

Iterate on documentation or compiler changes

A common local development loop for compiler work:

Build the project:
Terminal window
```
cargo build
```
Run the test suite:
Terminal window
```
cargo test
```
Compile a test agent to verify your changes:
Terminal window
```
cargo run -- compile path/to/agent.md
```
Verify the compiled output matches expectations:
Terminal window
```
cargo run -- check path/to/agent.lock.yml
```

If you are working on the docs site itself, run the site from site/ with your usual Astro workflow after installing dependencies.

What to verify before submitting changes

the project builds successfully
tests pass
your sample pipeline compiles cleanly
generated YAML matches the markdown source when checked