Quick Start

May 30, 2026 | 5 min read

1. Install the thin client

The thin client is a lightweight package that sends compile jobs to the Pyvorin remote API. No heavy compiler toolchain is installed locally.

pip install pyvorin-thin --extra-index-url https://pypi.pyvorin.com/simple

Or if you have the full pyvorin package (includes the local native compiler), simply run pip install pyvorin.

2. Initialize configuration

Create the default config file and verify API reachability.

pyvorin init

Config is stored at ~/.pyvorin/thin_config.json (Linux/macOS) or %APPDATA%\Pyvorin\thin_config.json (Windows).

3. Activate your license

Validate your license key and store it locally. The raw key is never sent in plain text.

pyvorin activate PYV-XXXX-XXXX-XXXX

4. Run the environment check

pyvorin doctor --network

5. Write a script

def main():
    total = 0
    for i in range(1000000):
        total += i
    return total

if __name__ == "__main__":
    print(main())

Save this as script.py.

6. Scan for compatibility

pyvorin scan script.py

7. Run with Pyvorin

pyvorin run script.py

8. Benchmark

pyvorin benchmark script.py --function main
pyvorin proof script.py