Skip to content

docs: lead the install instructions with uv, with uvx and pip as alternatives - #29

Merged
earakely-scale merged 1 commit into
mainfrom
docs/install-with-uv
Sep 30, 2026
Merged

earakely-scale merged 1 commit into
mainfrom
docs/install-with-uv

Conversation

@earakely-scale

@earakely-scale earakely-scale commented Sep 30, 2026 •

Copy link
Copy Markdown
Collaborator

The install instructions now lead with uv, and show uvx and pip as alternatives. The docs site's Getting Started page makes the same change in a companion PR.

Changes

  • README (also the PyPI project page):
    • install with uv tool install agentenv-framework, then agent-env run hello (the built-in task that needs no Docker, model or configuration)
    • try it without installing: uvx --from agentenv-framework agent-env run hello
    • install with pip, into a virtualenv
    • use the SDK in a project with uv add
    • the explorer needs the explorer extra and an .agentenv/config.toml; agent-env up refuses to start without one, and an empty file keeps every local default
    • the plugin-settings paragraph names uv add next to pip install
  • Protocol README: uv add agentenv-framework-protocol next to pip install.
  • AGENTS.md:
    • set up a checkout with uv sync --extra dev first, with the venv and pip route as the fallback
    • make install is described as the pip route
    • builds use uv build, which produces the same wheel (agent_env only) and sdist (src, tst, the protocol package) as python -m build

The CLI's own hints (agent-env up and the extras hint in the config loader) still say pip install, and this PR leaves them alone. The right command depends on how agent-env was installed. A generic uv tool install '…[explorer]' hint would also drop the plugins in a uv tool environment, so these hints are better made installer-aware in a separate change.

Verification

I ran every documented command on macOS (Apple Silicon) and Linux (Ubuntu 22.04), from PyPI (0.9.1256), with uv, tool and state directories isolated. All pass on both:

  • uv tool install, then agent-env run hello, and agent-env plugin list reports "uv tool"
  • uvx --from agentenv-framework agent-env run hello
  • pip in a venv, then agent-env run hello
  • uv add in a new project, then uv run agent-env run hello, and importing agent_env
  • the [explorer] extra through all three routes, with agent-env up --no-bootstrap answering on 127.0.0.1:8234 from a folder with an empty .agentenv/config.toml
  • uv add agentenv-framework-protocol and uv add 'agentenv-framework-protocol[agent]'
  • uv tool install '…[explorer]' over an existing install adds the extra without --force
  • uv build produces agentenv_framework-<version>-py3-none-any.whl and agentenv_framework-<version>.tar.gz with the contents AGENTS.md lists
  • tst/unit/test_check_plugin_api.py, which parses the README, passes

bump-version is set so the new README reaches PyPI.

🤖 Generated with Claude Code

RetriggerConfidence Score: 5/5

The documentation changes appear safe to merge.

What we checked:

  • Does hello need Docker?: The hello bundle uses a local work folder, and its file and shell checks run on the host rather than in a container.

Summary

The docs now lead with uv for installing and trying agent-env, while keeping uvx and pip as alternatives. Contributor and protocol-package instructions also add uv commands.

  • The main README covers the hello task, SDK installs, and the explorer’s setup needs.
  • Contributor docs put uv sync and uv build first; pip remains available.

Reviews (1) · Last reviewed commit: "docs: lead the install instructions with..."

…rnatives

The README, which is also the PyPI page, installs with uv tool install first, shows the uvx
one-liner that needs no install and keeps pip, and says what the explorer needs: its extra and
an .agentenv/config.toml. The protocol README names uv add next to pip. AGENTS.md sets up a
checkout with uv sync first and builds with uv build, which makes the same wheel and sdist as
python -m build.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@earakely-scale
earakely-scale requested a review from a team as a code owner September 30, 2026 21:56
@earakely-scale earakely-scale added documentation Improvements or additions to documentation bump-version labels Sep 30, 2026
@earakely-scale
earakely-scale merged commit b2beef2 into main Sep 30, 2026
11 checks passed
@earakely-scale
earakely-scale deleted the docs/install-with-uv branch September 30, 2026 22:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bump-version documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant