Connect to a server

Ask your administrator for:

• The server address, normally https://builds.example.com.
• Either an access token or permission to sign in through Perforce.
• The game and platform names used by your team.
• A local directory where downloaded builds should live.

Desktop app

On the sign-in screen:

1. Enter the server address.
2. Choose Token or Perforce login.
3. Choose your local build root.
4. Sign in.

For token login, paste the token when prompted. For Perforce login, make sure p4 is on PATH and you already have a live all-hosts ticket:

p4 login -a

Command-line client

Token login:

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

Perforce login:

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

Set the shared checkout directory:

vsync root D:\builds

On macOS or Linux, use a path such as ~/builds instead.

The login is stored for future sessions. Run vsync logout to remove the stored server and token; cached data and checkouts remain untouched.

CI credentials

Automation should not run interactive login. Provide credentials 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.