Commands
Commands
| Command | What it does |
|---|---|
zyvra init [name] | Create a project in the current folder. |
zyvra up | Start this project and the dashboard. |
zyvra down | Stop this project (--all stops everything). |
zyvra status | Show services and their ports. |
zyvra validate | Check zyvra.yaml. |
zyvra scenario list / activate | List or switch response scenarios. |
zyvra run [collection] | Run a collection’s requests with their assertions and scripts. For CI: the exit code, --junit file, --json file, --with-mocks, and --data users.csv to run once per row. |
zyvra import openapi <file> | Turn an OpenAPI 3.x spec into a collection. |
zyvra import postman <file> | Import a Postman collection (v2.0 or v2.1), environment or globals file. Credentials go to the encrypted store. |
zyvra export postman [collection] | Export a collection (or --env NAME, --globals) as Postman files. Secret values are never exported. |
zyvra trust | Allow this project’s scripts to run (--revoke undoes it). |
zyvra version | Show the version (--check also looks for a newer one). |
zyvra update | Install the newest release, after checking its signature. |
zyvra verify <file> | Check that a file was signed by Zyvra (it uses <file>.sig). |
Ports
The dashboard listens on port 7777 by default. Change it for one run with zyvra up --port 8080. Every mock service has its own port, set per service in the dashboard or with port: in zyvra.yaml. Two services cannot share a port.
Environment variables
| Variable | Meaning |
|---|---|
ZYVRA_HOME | Where Zyvra keeps its own data (the project list, the encrypted secret store, trust decisions). Defaults to a zyvra folder in your user configuration directory. |
ZYVRA_SECRET_<NAME> | The value of secret <NAME>, for CI where there is no stored secret. |
ZYVRA_NO_UPDATE_CHECK | Set to 1 to switch off the daily update check. |
ZYVRA_UPDATE_URL | Check for updates at another address (a mirror). The release must still be signed by Zyvra’s key. |
Good to know
- Scripts are code that runs on your computer. They stay off until you trust the project, with the Trust scripts button in the dashboard or
zyvra trust. Trust only projects whose scripts you have read. - To make a variable secret, click the lock on it on the Variables page. Its value is then stored encrypted outside the project file, is never shown again, and is masked in responses and history.
- Everything listens on
127.0.0.1only, so nothing is reachable from other machines.