getting-started

Getting Started

Detailed guide to installation, configuration, and first compile.

Published May 30, 2026

1. Install the Thin Client

Pyvorin is distributed as pyvorin-thin on our private package index. Install it with pip:

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

Verify the installation:

pyvorin --version

2. Initialise Configuration

Create the default configuration file. This stores endpoints, cache paths, and telemetry preferences locally.

pyvorin init

The config file lives at:

  • Linux / macOS: ~/.pyvorin/thin_config.json
  • Windows: %APPDATA%\Pyvorin\thin_config.json

3. Activate Your Licence

Validate and store your licence key. The key is hashed before any network transmission.

pyvorin activate PYV-XXXX-XXXX-XXXX

Check status at any time:

pyvorin licence-status

4. Run a Health Check

pyvorin doctor --network

5. Run Your First Script

# hello.py
def main():
    data = [x * 2 for x in range(1000)]
    return sum(data)

if __name__ == "__main__":
    print(main())
pyvorin run hello.py

6. Scan for Compatibility

pyvorin scan hello.py