Refresh quickstart walkthrough recording

This commit is contained in:
Thales Maciel 2026-03-09 23:06:21 -03:00
parent 0181de2563
commit 81636e86fb
3 changed files with 52 additions and 43 deletions

View file

@ -24,6 +24,42 @@ It exposes the same runtime in three public forms:
- Troubleshooting: [docs/troubleshooting.md](docs/troubleshooting.md) - Troubleshooting: [docs/troubleshooting.md](docs/troubleshooting.md)
- Changelog: [CHANGELOG.md](CHANGELOG.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
```
![Quickstart walkthrough](docs/assets/first-run.gif)
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 Hosts
Supported today: Supported today:
@ -45,30 +81,9 @@ Not supported today:
- Windows - Windows
- Linux hosts without working KVM at `/dev/kvm` - Linux hosts without working KVM at `/dev/kvm`
If you do not already have `uv`, install it first: ## Detailed Walkthrough
```bash If you want the expanded version of the canonical quickstart, use the step-by-step flow below.
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`.
### 1. Check the host ### 1. Check the host

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.5 MiB

After

Width:  |  Height:  |  Size: 2.4 MiB

Before After
Before After

View file

@ -5,7 +5,7 @@ Require uv
Set Shell "zsh" Set Shell "zsh"
Set FontSize 18 Set FontSize 18
Set Width 1200 Set Width 1200
Set Height 820 Set Height 760
Set Theme "Dracula" Set Theme "Dracula"
Set TypingSpeed 35ms Set TypingSpeed 35ms
Set Padding 24 Set Padding 24
@ -16,35 +16,29 @@ Type "cd /home/thales/projects/personal/pyro"
Enter Enter
Type "export UV_CACHE_DIR=.uv-cache" Type "export UV_CACHE_DIR=.uv-cache"
Enter Enter
Type "export PYRO_ENVIRONMENT_CACHE_DIR=$(mktemp -d)"
Enter
Type "uvx --from pyro-mcp pyro --version >/dev/null"
Enter
Show Show
Type "printf '\\n# Check host support from the repo checkout\\n'" Type "# Check that the host can boot and run guests"
Enter Enter
Sleep 800ms Sleep 700ms
Type "uv run pyro doctor" Type "uvx --from pyro-mcp pyro doctor"
Enter Enter
Sleep 2200ms Sleep 2200ms
Type "printf '\\n# Inspect and pull the default environment\\n'" Type "# Pull the default environment into a fresh local cache"
Enter Enter
Sleep 800ms Sleep 700ms
Type "uv run pyro env list" Type "uvx --from pyro-mcp pyro env pull debian:12"
Enter
Sleep 1800ms
Type "uv run pyro env pull debian:12"
Enter
Sleep 1800ms
Type "printf '\\n# Run one command in an isolated guest\\n'"
Enter
Sleep 800ms
Type "uv run pyro run debian:12 -- git --version"
Enter Enter
Sleep 2200ms Sleep 2200ms
Type "printf '\\n# Prove the one-shot VM lifecycle demo\\n'" Type "# Run one isolated command inside an ephemeral microVM"
Enter Enter
Sleep 800ms Sleep 700ms
Type "uv run pyro demo" Type "uvx --from pyro-mcp pyro run debian:12 -- git --version"
Enter Enter
Sleep 2600ms Sleep 2600ms