Align quickstart guidance across docs and CLI
This commit is contained in:
parent
81636e86fb
commit
694be0730b
5 changed files with 44 additions and 10 deletions
|
|
@ -2,8 +2,9 @@
|
|||
|
||||
This is the intended evaluator path for a first successful run on a supported host.
|
||||
Copy the commands as-is. Paths and timing values will differ on your machine.
|
||||
If you are running from a source checkout instead of the published package, replace
|
||||
`uvx --from pyro-mcp pyro` with `uv run pyro`.
|
||||
The same sequence works with an installed `pyro` binary by dropping the
|
||||
`uvx --from pyro-mcp` prefix. If you are running from a source checkout instead
|
||||
of the published package, replace `pyro` with `uv run pyro`.
|
||||
|
||||
## 1. Verify the host
|
||||
|
||||
|
|
|
|||
|
|
@ -35,9 +35,25 @@ Use these command forms consistently:
|
|||
|
||||
## Fastest Evaluation Path
|
||||
|
||||
Use the package directly without a manual install:
|
||||
Use either of these equivalent evaluator paths:
|
||||
|
||||
If you are running from a repo checkout instead, replace `uvx --from pyro-mcp pyro` with `uv run pyro`.
|
||||
```bash
|
||||
# Package without install
|
||||
uvx --from pyro-mcp pyro doctor
|
||||
uvx --from pyro-mcp pyro env list
|
||||
uvx --from pyro-mcp pyro env pull debian:12
|
||||
uvx --from pyro-mcp pyro run debian:12 -- git --version
|
||||
```
|
||||
|
||||
```bash
|
||||
# Already installed
|
||||
pyro doctor
|
||||
pyro env list
|
||||
pyro env pull debian:12
|
||||
pyro run debian:12 -- git --version
|
||||
```
|
||||
|
||||
If you are running from a repo checkout instead, replace `pyro` with `uv run pyro`.
|
||||
|
||||
### 1. Check the host first
|
||||
|
||||
|
|
@ -133,6 +149,8 @@ When you are done evaluating and want to remove stale cached environments, run `
|
|||
|
||||
## Installed CLI
|
||||
|
||||
If you already installed the package, the same evaluator path works with plain `pyro ...`:
|
||||
|
||||
```bash
|
||||
uv tool install pyro-mcp
|
||||
pyro --version
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue