CLI Setup

The synctl CLI uses a personal access token to authenticate with Control Plane's API and provides functionality not exposed via the UI.

Download the CLI

Download the latest version of the CLI from Github.

Personal access tokens are generated in your Profile under the Personal Access Token tab. They take the form of:

uat_vHVOMYLvwoAzJziEYzlxUeuvvKFDYlNSAbjBYdhCiZancDkKGILvlKrDUSPQljOo

synctl requires Control Plane's API address and personal access token be provide for every command.

Use the --server flag or set the SCP_SERVER environment variable:

export SCP_SERVER=http://127.0.0.1:8080

Use the --token flag or set the SCP_TOKEN environment variable:

export SCP_TOKEN=uat_vHVOMYLvwoAzJziEYzlxUeuvvKFDYlNSAbjBYd...