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

@ -12,6 +12,7 @@ It exposes the same runtime in three public forms:
- Install: [docs/install.md](docs/install.md)
- First run transcript: [docs/first-run.md](docs/first-run.md)
- PyPI package: [pypi.org/project/pyro-mcp](https://pypi.org/project/pyro-mcp/)
- Host requirements: [docs/host-requirements.md](docs/host-requirements.md)
- Integration targets: [docs/integrations.md](docs/integrations.md)
- Public contract: [docs/public-contract.md](docs/public-contract.md)
@ -45,6 +46,19 @@ If you do not already have `uv`, install it first:
python -m pip install uv
```
Published package path:
```bash
uvx --from pyro-mcp pyro doctor
uv tool install pyro-mcp
```
Source checkout path:
```bash
uv run pyro doctor
```
## 5-Minute Evaluation
Use the package directly without a manual install:
@ -85,6 +99,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 [docs/host-requirements.md](docs/host-requirements.md) for the full host requirements.
### 3. Run one command in a guest
```bash
@ -94,10 +112,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.
### 4. Optional demos
```bash
@ -115,6 +137,12 @@ The public user-facing interface is `pyro` and `Pyro`. After the CLI validation
- `from pyro_mcp import Pyro` for Python orchestration
- `pyro mcp serve` for MCP clients
Command forms:
- published package without install: `uvx --from pyro-mcp pyro ...`
- installed package: `pyro ...`
- source checkout: `uv run pyro ...`
`Makefile` targets are contributor conveniences for this repository and are not the primary product UX.
## Official Environments