Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 5 additions & 3 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ When `gateway_url` / `api_key` are not passed explicitly, the SDK resolves each
fallback chain (see `agent_assembly.core.gateway_resolver`):

1. **Explicit argument** β€” the value you pass to `init_assembly()`.
2. **Environment variable** β€” `AAASM_GATEWAY_URL` / `AAASM_API_KEY`.
2. **Environment variable** β€” `AA_GATEWAY_URL` / `AA_API_KEY`. (The legacy
`AAASM_GATEWAY_URL` / `AAASM_API_KEY` names still resolve but emit a
`DeprecationWarning` β€” prefer the `AA_*` names.)
3. **Config file** β€” `~/.aasm/config.yaml`.
4. **Local default** β€” probe `http://localhost:7391/healthz`; if no gateway is running, the
SDK attempts to **auto-start** a local one (`aasm start --mode local --foreground`).
Expand All @@ -71,8 +73,8 @@ For the full gateway configuration surface (policy files, budgets, mTLS) and the
[CLI reference](https://docs.agent-assembly.com/core/latest/cli/overview.html) docs.

```bash
export AAASM_GATEWAY_URL="https://gateway.example.com"
export AAASM_API_KEY="…"
export AA_GATEWAY_URL="https://gateway.example.com"
export AA_API_KEY="…"
```

### Config file format
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/preparing-the-runtime-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ uv run python src/main.py
The examples pass `gateway_url` / `api_key` **explicitly** to `init_assembly()`, reading
them from the `AGENT_ASSEMBLY_*` variables shown above and defaulting to
`http://localhost:8080`. The SDK *itself* has a separate built-in resolver chain that,
when you **omit** those arguments, reads `AASM_GATEWAY_URL` / `AASM_API_KEY`, then
when you **omit** those arguments, reads `AA_GATEWAY_URL` / `AA_API_KEY`, then
`~/.aasm/config.yaml`, then probes a local gateway on `http://localhost:7391`. See
[Configuration](../configuration.md#resolution-order) for that resolver. The examples use
explicit arguments, so they use the `AGENT_ASSEMBLY_*` names and the `:8080` default β€”
Expand Down
4 changes: 2 additions & 2 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ safe.

| Message | Cause | Fix |
| --- | --- | --- |
| `gateway_url is required` | No gateway URL could be resolved (no argument, no `AAASM_GATEWAY_URL`, no config file, no local gateway). | Pass `gateway_url=...`, set `AAASM_GATEWAY_URL`, or start a local gateway. See [Configuration](configuration.md#resolution-order). |
| `gateway_url is required` | No gateway URL could be resolved (no argument, no `AA_GATEWAY_URL`, no config file, no local gateway). | Pass `gateway_url=...`, set `AA_GATEWAY_URL`, or start a local gateway. See [Configuration](configuration.md#resolution-order). |
| `mode must be one of: auto, ebpf, proxy, sdk-only` | An unknown `mode` value. | Use one of the four valid modes. |
| `enforcement_mode must be one of: enforce, observe, disabled` | An unknown `enforcement_mode`. | Use a valid posture or leave it `None`. |
| `eBPF mode is not supported on this platform.` | `mode="ebpf"` on a non-Linux host. | Use `mode="sdk-only"` or `mode="proxy"` off Linux. |
Expand All @@ -24,7 +24,7 @@ network layer but the gateway didn't answer.

- Confirm the gateway is running and the URL is correct β€” by default the SDK probes
`http://localhost:7391/healthz`.
- Check `AAASM_GATEWAY_URL` / `AAASM_API_KEY` aren't pointing somewhere stale.
- Check `AA_GATEWAY_URL` / `AA_API_KEY` (or the deprecated `AAASM_*` aliases) aren't pointing somewhere stale.
- For a quick local loop, run an `aasm` gateway yourself, or let the SDK auto-start one
(`aasm start --mode local --foreground`). If auto-start fails, ensure the `aasm` binary is
on `PATH` β€” install it via the `agent-assembly[runtime]` extra or the Homebrew tap.
Expand Down