Skip to content

[AAASM-4338] 🐛 (core): Add --pre/prerelease to SDK-emitted install hints #231

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

Merged
Chisanan232 merged 4 commits into from
Jul 9, 2026
Merged

[AAASM-4338] 🐛 (core): Add --pre/prerelease to SDK-emitted install hints #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4c26913
🐛 (core): Add --pre to SDK-emitted runtime install hints
Chisanan232 Jul 9, 2026
1e76ba4
📝 (readme): Add prerelease handling to uv add
Chisanan232 Jul 9, 2026
4a273f6
📝 (docs): Add --prerelease=allow to install_uv macro snippet
Chisanan232 Jul 9, 2026
ab2b576
🐛 (core): Add --pre to gateway_resolver runtime-install hint
Chisanan232 Jul 9, 2026
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
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,14 @@ is the pure-Python client and expects an `aasm` runtime to be reachable some oth
With [`uv`](https://docs.astral.sh/uv/):

```bash
uv add agent-assembly
uv add --prerelease=allow agent-assembly
```

> **`--prerelease=allow` is required for now.** Unlike `pip`, `uv` refuses to
> resolve pre-releases unless you opt in. Agent Assembly is currently published only
> as a pre-release on PyPI, so `uv add agent-assembly` fails to resolve without it.
> Drop the flag once a stable (non-pre-release) version is published.

To track unreleased changes, install from the `master` branch:

```bash
Expand Down
2 changes: 1 addition & 1 deletion agent_assembly/_install.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

INSTALL_HINT = (
"agent-assembly runtime binary `aasm` was not found.\n"
" Install the platform wheel: pip install agent-assembly[runtime]\n"
" Install the platform wheel: pip install --pre agent-assembly[runtime]\n"
" Or install manually: brew install ai-agent-assembly/tap/aasm\n"
" curl -fsSL https://agent-assembly.com/install.sh | sh"
)
Expand Down
2 changes: 1 addition & 1 deletion agent_assembly/core/gateway_resolver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ def _auto_start_gateway(
if aasm_path is None:
raise ConfigurationError(
f"No gateway found at {base_url} and 'aasm' is not on PATH. "
"Install it with: pip install 'agent-assembly[runtime]'"
"Install it with: pip install --pre 'agent-assembly[runtime]'"
)

subprocess.Popen(
Expand Down
2 changes: 1 addition & 1 deletion agent_assembly/runtime.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@

INSTALL_HINT = (
"agent-assembly runtime not found.\n"
" Install with: pip install agent-assembly[runtime]\n"
" Install with: pip install --pre agent-assembly[runtime]\n"
" Or manually: brew install ai-agent-assembly/tap/aasm\n"
" curl -fsSL https://agent-assembly.com/install.sh | sh"
)
Expand Down
2 changes: 1 addition & 1 deletion docs_macros.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ def define_env(env: Any) -> None:
"pypi": "https://pypi.org/project/agent-assembly/",
},
"commands": {
"install_uv": "uv add agent-assembly",
"install_uv": "uv add --prerelease=allow agent-assembly",
"install_pip": "pip install --pre agent-assembly",
"install_pip_runtime": "pip install --pre 'agent-assembly[runtime]'",
},
Expand Down