Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.velatir.com/llms.txt

Use this file to discover all available pages before exploring further.

Overview

The Velatir desktop client ships as a signed installer for each supported platform. The installer is intentionally small. At first run, the bundled agent downloads the rest of the application and stages it in a versioned directory so future updates can swap atomically. You need an API key from the Velatir dashboard to complete the installation. Generate one on the Setup tab of your workspace.
This page covers single-device installation. For organisation-wide rollouts via Microsoft Intune, Jamf Pro, or other MDM platforms, see Enterprise deployment.

Prerequisites

RequirementDetail
Operating systemWindows 10 or 11 (x64 or arm64), or macOS 13 Ventura or later
Account typeAdministrator rights on the device
NetworkOutbound HTTPS to api.velatir.com and Velatir’s update storage
API keyA project API key from the Velatir dashboard

Install on Windows

Velatir installs in a single command from an elevated command prompt. The MSI stages your API key as it installs, so there is no separate sign-in step.

Download the installer

Download the latest signed MSI for your architecture:

Velatir for Windows (x64)

For Intel and AMD devices.

Velatir for Windows (arm64)

For Snapdragon and other arm64 devices.
Generate an API key on the Setup tab of your workspace in the Velatir dashboard.

Install silently with your API key

Open Command Prompt as administrator, then run the installer against the file you downloaded, passing your API key:
msiexec /i Velatir-Bootstrap-x64.msi VELATIR_API_KEY=vltr_your_api_key_here /qn
Use the full path to the downloaded file (for example %USERPROFILE%\Downloads\Velatir-Bootstrap-x64.msi), and substitute Velatir-Bootstrap-arm64.msi on arm64 devices.The /qn switch runs the install with no UI. From its single elevation the MSI places the Velatir Agent into C:\Program Files\Velatir\, installs the Velatir CA certificate into the trusted root store, registers the Wintun driver used for transparent traffic interception, registers a scheduled task that starts the agent at user logon, and stages your API key (the VELATIR_API_KEY property is hidden from MSI logs). The host starts automatically once the install completes.
The full list of permissions the installer requests is documented in Permissions.

Confirm interception

Verify the agent is running:
velatir status
The output should show the agent and host running, the transparent proxy active, and a masked API key matching the value you passed.Then open a supported AI application (for example, GitHub Copilot in VS Code or Claude Code in a terminal). Send a prompt, then check your Velatir dashboard. The interaction should appear as a trace within a few seconds.

What Gets Installed

ComponentWindowsmacOS
Agent (background supervisor)C:\Program Files\Velatir\VelatirAgent.exeBundled in /Applications/Velatir.app
Host (proxy and trace pipeline)C:\Program Files\Velatir\app\current\Velatir.exeBundled in /Applications/Velatir.app
CLIvelatir on the system pathvelatir on the system path
Velatir CA certificateLocalMachine\RootSystem keychain
Traffic interceptionWintun virtual adapter + tun2socks helperNetwork system extension
The full architecture of these components is described in How it works.

Updates

After the first install the agent checks for new payloads every four hours and applies them transparently. You can also force an update at any time:
velatir update --apply
The previous version is retained on disk until the new version starts successfully, so there is no in-between state.

Uninstall

Uninstall from Settings > Apps > Installed apps, or from an elevated terminal:
msiexec /x {VELATIR-PRODUCT-CODE-PLACEHOLDER} /qn
Uninstall removes the agent, the host, the scheduled task, the Wintun adapter, and the CA certificate from the trusted root store.

Next Steps

Permissions

Detailed reference for the permissions the installer requests.

VPN compatibility

How the desktop client behaves alongside corporate VPNs.

CLI reference

Configure and control the desktop client from the command line.

Troubleshooting

Resolve common install and first-run issues.