Clarify package install and run expectations

This commit is contained in:
Thales Maciel 2026-03-09 21:36:36 -03:00
parent b2ea56db4c
commit be654b5b41
6 changed files with 76 additions and 5 deletions

View file

@ -27,6 +27,12 @@ If you do not already have `uv`, install it first:
python -m pip install uv
```
Use these command forms consistently:
- published package without install: `uvx --from pyro-mcp pyro ...`
- installed package: `pyro ...`
- source checkout: `uv run pyro ...`
## Fastest Evaluation Path
Use the package directly without a manual install:
@ -71,6 +77,10 @@ debian:12-build [installed|not installed] Debian 12 environment with Git and com
uvx --from pyro-mcp pyro env pull debian:12
```
The first pull downloads an OCI environment from public Docker Hub, requires outbound HTTPS
access to `registry-1.docker.io`, and needs local cache space for the guest image. See
[host-requirements.md](host-requirements.md) for the full host requirements.
### 4. Run one command in a guest
```bash
@ -80,10 +90,14 @@ uvx --from pyro-mcp pyro run debian:12 -- git --version
Expected success signals:
```bash
git version ...
[run] environment=debian:12 execution_mode=guest_vsock exit_code=0 duration_ms=...
git version ...
```
The guest command output and the `[run] ...` summary are written to different streams, so they
may appear in either order in terminals or capture tools. Use `--json` if you need a
deterministic structured result.
If guest execution is unavailable, the command fails unless you explicitly pass
`--allow-host-compat`.