Repository navigation
docs: lead the install instructions with uv, with uvx and pip as alternatives - #29
Merged
Merged
Conversation
…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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
uv tool install agentenv-framework, thenagent-env run hello(the built-in task that needs no Docker, model or configuration)uvx --from agentenv-framework agent-env run hellouv addexplorerextra and an.agentenv/config.toml;agent-env uprefuses to start without one, and an empty file keeps every local defaultuv addnext topip installuv add agentenv-framework-protocolnext topip install.uv sync --extra devfirst, with the venv and pip route as the fallbackmake installis described as the pip routeuv build, which produces the same wheel (agent_envonly) and sdist (src,tst, the protocol package) aspython -m buildThe CLI's own hints (
agent-env upand the extras hint in the config loader) still saypip install, and this PR leaves them alone. The right command depends on how agent-env was installed. A genericuv 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, thenagent-env run hello, andagent-env plugin listreports "uv tool"uvx --from agentenv-framework agent-env run helloagent-env run hellouv addin a new project, thenuv run agent-env run hello, and importingagent_env[explorer]extra through all three routes, withagent-env up --no-bootstrapanswering on127.0.0.1:8234from a folder with an empty.agentenv/config.tomluv add agentenv-framework-protocolanduv add 'agentenv-framework-protocol[agent]'uv tool install '…[explorer]'over an existing install adds the extra without--forceuv buildproducesagentenv_framework-<version>-py3-none-any.whlandagentenv_framework-<version>.tar.gzwith the contents AGENTS.md liststst/unit/test_check_plugin_api.py, which parses the README, passesbump-versionis set so the new README reaches PyPI.🤖 Generated with Claude Code
The documentation changes appear safe to merge.
What we checked:
hellobundle 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.
hellotask, SDK installs, and the explorer’s setup needs.uv syncanduv buildfirst; pip remains available.Reviews (1) · Last reviewed commit: "docs: lead the install instructions with..."