Connect to a server

Your administrator sends you an invite link. Open it, pick a password, and you have an account. Ask them for:

• The server address, such as https://builds.example.com.
• The game and platform names used by your team.
• A local directory where downloaded builds should live.

Desktop app

Follow the desktop quick start. Raw access tokens are intended for automation, but the desktop app accepts one through Use an access token instead when necessary.

Command-line client

vsync login --server https://builds.example.com

Enter your user name or email and password when prompted. Pasting an access token at the name prompt also works.

Set the shared checkout directory:

vsync root D:\builds

On macOS or Linux, use a path such as ~/builds instead. The directory is marked for the server you just logged in to; each server gets its own build root.

Check the connection and list available games:

vsync doctor
vsync game list

The login is stored for future sessions; it expires after 30 days, after which you simply sign in again. Run vsync logout to revoke the token on the server and remove the stored login; cached data and checkouts remain untouched.

CI credentials

Automation should not run interactive login. Ask an admin for a CI token and provide it through the environment:

export VSYNC_SERVER=https://builds.example.com
export VSYNC_TOKEN=vs_...
export VSYNC_GAME=my-game
export VSYNC_PLATFORM=win64

Environment values take precedence over the stored login.

In Windows PowerShell, set the same values with $env:, for example:

$env:VSYNC_SERVER = "https://builds.example.com"
$env:VSYNC_TOKEN = "vs_..."
$env:VSYNC_GAME = "my-game"
$env:VSYNC_PLATFORM = "win64"