Refresh quickstart walkthrough recording
This commit is contained in:
parent
0181de2563
commit
81636e86fb
3 changed files with 52 additions and 43 deletions
61
README.md
61
README.md
|
|
@ -24,6 +24,42 @@ It exposes the same runtime in three public forms:
|
|||
- Troubleshooting: [docs/troubleshooting.md](docs/troubleshooting.md)
|
||||
- Changelog: [CHANGELOG.md](CHANGELOG.md)
|
||||
|
||||
## Quickstart
|
||||
|
||||
Canonical published-package path:
|
||||
|
||||
```bash
|
||||
python -m pip install uv
|
||||
uvx --from pyro-mcp pyro doctor
|
||||
uvx --from pyro-mcp pyro env pull debian:12
|
||||
uvx --from pyro-mcp pyro run debian:12 -- git --version
|
||||
```
|
||||
|
||||

|
||||
|
||||
From a repo checkout, replace `uvx --from pyro-mcp pyro` with `uv run pyro`.
|
||||
|
||||
What success looks like:
|
||||
|
||||
```bash
|
||||
Platform: linux-x86_64
|
||||
Runtime: PASS
|
||||
...
|
||||
Pulled: debian:12
|
||||
...
|
||||
[run] environment=debian:12 execution_mode=guest_vsock exit_code=0 duration_ms=...
|
||||
git version ...
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
After the quickstart works:
|
||||
|
||||
- inspect the catalog with `uvx --from pyro-mcp pyro env list`
|
||||
- prove the full one-shot lifecycle with `uvx --from pyro-mcp pyro demo`
|
||||
- move to Python or MCP via [docs/integrations.md](docs/integrations.md)
|
||||
|
||||
## Supported Hosts
|
||||
|
||||
Supported today:
|
||||
|
|
@ -45,30 +81,9 @@ Not supported today:
|
|||
- Windows
|
||||
- Linux hosts without working KVM at `/dev/kvm`
|
||||
|
||||
If you do not already have `uv`, install it first:
|
||||
## Detailed Walkthrough
|
||||
|
||||
```bash
|
||||
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:
|
||||
|
||||
If you are running from a repo checkout instead, replace `uvx --from pyro-mcp pyro` with `uv run pyro`.
|
||||
If you want the expanded version of the canonical quickstart, use the step-by-step flow below.
|
||||
|
||||
### 1. Check the host
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue