ProvelyThis page lists 35 commands of the provely binary, from its command definition. A command that the next release renames is not on this page.
How do I install the binary?
curl -fsSL https://provely.sh/install.sh | sh
powershell -c "irm https://provely.sh/install.ps1 | iex"
Which options does every command take?
| Option | Short | What it does |
|---|---|---|
--api-url <value> | - | The control plane URL. Overrides the file and PROVELY_API_URL |
--authoriser-key <value> (repeatable) | - | An authoriser key as <key_id>=<public_key_hex>. The sidecar verifies a bundle with it |
--config <value> | - | The configuration file. Default: ~/.config/provely/config.toml |
--json | - | Write JSON instead of text |
--timeout <value> | - | The request timeout. Example: 30s |
--trusted-key <value> (repeatable) | - | A trusted receipt key as <key_id>=<public_key_hex>. Repeat the flag for more keys |
Which commands does this page document?
| Command | What it does | Options |
|---|---|---|
provely action-result | Submit the provider acknowledgement of an action | --error-code <value>, --error-message <value>, --idempotency-key <value>, <operation_id>, --provider-api-version <value>, --result <value>, --status <value>, --status-code <value> |
provely begin | Open an operation. The answer carries the operation id and correlation metadata | --contract <value>, --contract-version <value>, --idempotency-key <value>, --input <value>, --intent <value>, --provider-api-version <value> |
provely completions | Print the completion script of a shell. Example: provely completions zsh > _provely | <shell> |
provely config | Show the effective configuration. The key is masked | - |
provely config show | Print the effective configuration | - |
provely demo | - | --console-url <value>, --dir <value>, --dry-run, --runner <value>, --sample <value>, <sample_args> (repeatable), --watch |
provely guard | - | - |
provely guard check | - | --confirmation <value>, --mcp-server <value>, --posture-cache <value>, --tool <value> |
provely init | Write guidance files for an agent into a project | --agent <value>, --apply, --code, --dry-run, --entry <value> (repeatable), --force, --list, --out <value>, --profiles-dir <value> |
provely login | Sign in with the device flow, and write the key into the configuration file | --no-browser |
provely mcp | Run the MCP server on stdio. The tools proxy to the control plane | - |
provely receipt | Work with evidence receipts | - |
provely receipt fetch | Fetch the receipt of an operation from the control plane | <operation_id>, --out <value> |
provely receipt validate | Check a receipt file offline: canonical JSON, Ed25519 signature, and the trusted key | <file> |
provely review | Work with the review queue that scan --submit opens | - |
provely review status | Read the state of a review. Exit 0 when complete, exit 10 when a person must act | <review_id> |
provely rules | Scan, review, sign, sync, and learn the rules of each agent | - |
provely rules keys | Make your signing key under ~/.provely/keys, and print the entry for the signer list | --dir <value>, --id <value>, --signer <value> |
provely rules learn | Learn rules from the logs of runs. A rule that needs no signature applies; another one waits for a person. Exit 0 | --from <value> (repeatable), --min-support <value>, --no-auto-apply, --replay <value> (repeatable), --root <value> |
provely rules review | List each agent, tool, check, and rule, and edit the rules | --accept <value> (repeatable), --base <value>, --check, --until <value>, --interactive, --why <value>, --reject <value> (repeatable), --remove <value> (repeatable), --revert <value> (repeatable), --root <value>, --set <value> (repeatable) |
provely rules scan | Read the code, write .provely/.cache/, and print each rule with its status. Exit 0 | --no-write, <paths> (repeatable), --scanner-rules <value> |
provely rules sign | Sign the rules with your key. A rule that cannot change is refused. Exit 0 signed, 1 refused | --key <value>, --root <value> |
provely rules sync | Copy the rules between two sources. With no source, sync .provely with provely | --app <value>, <from>, --ref <value>, --root <value>, --scope <value>, <to> |
provely scan | Find side-effecting calls in TypeScript or JavaScript code that no verification follows | --agents, --compile, --diff <value>, <paths> (repeatable), --rules <value>, --submit, --surfaces |
provely session | - | - |
provely session end | End a session. With no id, the command reads .provely/session | <session_id> |
provely session show | - | <session_id> |
provely session start | Open a session. The command prints the id and writes .provely/session | --host <value>, --tag <value> (repeatable) |
provely sidecar | Run the sidecar. This version serves the check and the composer | --check, --environment <value>, --listen <value>, --name <value>, --posture <value>, --proxy-allow-remote, --proxy-client-ca <value>, --proxy-listen <value>, --proxy-tls-cert <value>, --proxy-tls-key <value>, --state-dir <value> |
provely sidecar compose | Compose the effective risk profile of a group set. The command reads no plane | --request <value>, --unsigned |
provely skill | Work with service verification skills | - |
provely skill generate | Write the review bundle of one integration to .provely/build/<name>/ | --api-version <value>, --docs <value>, --force, --name <value>, --openapi <value>, --out <value>, <provider> |
provely status | Read the state of an operation. The exit code carries the verdict | --ignore-schedule, --open, <operation_id>, --wait <value> |
provely verify | Ask the runtime to verify an operation. The exit code carries the verdict | --ignore-schedule, --open, <operation_id>, --wait <value> |
provely watch | - | --fail-on <value>, --kind <value>, --session <value> |
How do I turn on shell completion?
Run provely completions <shell>. The shell is one of bash, zsh, fish, powershell.
provely completions bash > provely.completion
Where this page comes from
A generator writes this page from the files below. A test fails when the page differs from them.
| File | Commit | Committed |
|---|---|---|
cli/commands.json | 688360f1 | 2026-10-17 |
deploy/clients/install/install.sh | 704c2b5e | 2026-10-16 |
deploy/clients/install/install.ps1 | 704c2b5e | 2026-10-16 |