Synadia Control Plane CLI

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.

Generate a Personal Access Token

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

uat_vHVOMYLvwoAzJziEYzlxUeuvvKFDYlNSAbjBYdhCiZancDkKGILvlKrDUSPQljOo

Configure the CLI

synctl requires several options be provide to interact with control plane api. These can be provided multiple ways including config file, environment variable, and cli flags.

Config file

synctl look for and load configuration options from a config file. By default synctl will look in the path: {config home}/synadia/synctl/ for a file named config. The file format is indicated by the extension: .json, .yaml, .toml, .hcl. Config home is either $XDG_CONFIG_HOME if set or $HOME/.config if not.

$HOME/.config/synadia/synctl/config.json:

{
  "server": "http://127.0.0.1:8080",
  "token": "uat_vHVOMYLvwoAzJziEYzlxUeuvvKFDYlNSAbjBYdhCiZancDkKGILvlKrDUSPQljOo"
}

$XDG_CONFIG_HOME/synadia/synctl/config.yaml:

server: 'http://127.0.0.1:8080'
token: 'uat_vHVOMYLvwoAzJziEYzlxUeuvvKFDYlNSAbjBYdhCiZancDkKGILvlKrDUSPQljOo'

The full path to the config file can be overridden using the $SCP_CONFIG environment variable:

export SCP_CONFIG=/tmp/scp-config.yaml

Config Options