Skip to content

docs: add Runtimes section to README #1998

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: add Runtimes section to README #1998

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -464,6 +464,39 @@ PR triggers active alongside a schedule or pipeline trigger.

---

## Runtimes

The `runtimes` field auto-installs language environments before the agent
starts — unlike `tools:` (agent capabilities), runtimes are execution
environments the compiler wires up via pipeline steps, network allowlist
entries, and bash command allow-list additions.

```yaml
runtimes:
python:
version: "3.12"
node:
version: "22.x"
dotnet:
version: "8.0.x"
lean:
toolchain: "leanprover/lean4:v4.29.1"
```

| Runtime | Install mechanism | Notes |
|---------|-------------------|-------|
| `python` | `UsePythonVersion@0` (+ `PipAuthenticate@1` if `feed-url` is set) | Adds `python`, `pip`, `uv` to the bash allow-list |
| `node` | `UseNode@1` (+ `npmAuthenticate@0` if `feed-url`/`config` is set) | Adds `node`, `npm`, `npx` to the bash allow-list |
| `dotnet` | `UseDotNet@2` (+ `NuGetAuthenticate@1` if `feed-url`/`config` is set) | Adds `dotnet`; `version: "global.json"` auto-discovers SDKs from repo `global.json` files |
| `lean` | elan toolchain install | Adds `lean`, `lake`, `elan`; auto-pins to a repo `lean-toolchain` file if present |

Each runtime can be enabled with a bare `true` for defaults, or an object for
version pinning and internal feed configuration. See
[`docs/runtimes.md`](docs/runtimes.md) for the full field reference,
including feed-authentication caveats and AWF mount/PATH details per runtime.

---

## MCP Servers

MCP (Model Context Protocol) servers give the agent access to external tools.
Expand Down