CLI Reference

May 30, 2026 | 5 min read

Global Options

FlagDescription
--versionShow the thin client version and exit.
--helpShow help for any command or subcommand.

Installation & Setup

pyvorin init

Create the default configuration file and run an API health check.

pyvorin init [--force]

pyvorin doctor

Run environment diagnostics.

pyvorin doctor [--network] [--full] [--json]

pyvorin config-show

Display the current resolved configuration. Secrets are redacted.

pyvorin config-set

Set a configuration value with automatic type coercion.

pyvorin config-set <KEY> <VALUE>

Licensing

pyvorin activate

Validate a license key online and store it locally.

pyvorin activate <LICENSE_KEY> [--api-url URL]

pyvorin licence-status

Check the stored license validity, tier, expiry, and usage caps.

pyvorin licence-check

Validate a license key online without storing it.

pyvorin licence-check --key PYV-XXXX

Compilation & Execution

pyvorin scan

Statically scan a Python file for Pyvorin compatibility.

pyvorin scan <PATH> [--format text|json]

pyvorin compile

Submit a remote compile job asynchronously.

pyvorin compile [PATH] [--function FUNC] [--target TARGET] [--include-source]
  [--status JOB_ID] [--api-url URL] [--project-root DIR]
  [--include PATTERN] [--exclude PATTERN]
  [--bundle-all-project] [--dry-run-bundle]
  [--print-bundle-manifest]

pyvorin run

Execute a Python script through Pyvorin.

pyvorin run <PATH> [--function main] [--local-native]
  [--fallback] [--no-fallback] [--api-url URL]

pyvorin benchmark

Run an honest benchmark comparing CPython vs Pyvorin.

pyvorin benchmark <PATH> [--function benchmark] [--runs 5]

pyvorin proof

Run a full Speed Proof: scan, timing, correctness check, savings estimate, and report.

pyvorin proof <PATH> [--remote] [--runs-per-day 10] [--size small|medium|large]

Jobs & Artifacts

pyvorin job status <JOB_ID>

pyvorin job details <JOB_ID>

pyvorin jobs list [--limit 20]

pyvorin jobs show <JOB_ID>

pyvorin artifacts <ARTIFACT_ID>

pyvorin artifacts-download <ARTIFACT_ID> [--output PATH]

Reporting & Telemetry

pyvorin report

pyvorin report-job <JOB_ID>

pyvorin sync

pyvorin telemetry status|on|off

pyvorin privacy status

pyvorin privacy set store-raw-source true|false

Exit Codes

CodeMeaning
0Success.
1General error.
2Misuse of command.