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

@ -209,8 +209,19 @@ def _build_parser() -> argparse.ArgumentParser:
pull_parser = env_subparsers.add_parser(
"pull",
help="Install an environment into the local cache.",
description="Download and install one official environment into the local cache.",
epilog="Example:\n pyro env pull debian:12",
description=(
"Download and install one official environment into the local cache from "
"the configured OCI registry."
),
epilog=dedent(
"""
Example:
pyro env pull debian:12
The first pull downloads from public Docker Hub, requires outbound HTTPS,
and needs local cache space for the guest image.
"""
),
formatter_class=_HelpFormatter,
)
pull_parser.add_argument(
@ -288,6 +299,10 @@ def _build_parser() -> argparse.ArgumentParser:
Examples:
pyro run debian:12 -- git --version
pyro run debian:12 --network -- git ls-remote https://github.com/octocat/Hello-World.git
The guest command output and the [run] summary are written to different
streams, so they may appear in either order. Use --json for a deterministic
structured result.
"""
),
formatter_class=_HelpFormatter,