Skip to content

Basic Usage⚓︎

Quick install⚓︎

Linux or macOS⚓︎

Install the latest version with the following command:

1
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/sourceplusplus/interface-cli/master/scripts/install.sh)"

Windows⚓︎

Note: You will need to start cmd in administrator mode.

1
curl -LO "https://raw.githubusercontent.com/sourceplusplus/interface-cli/master/scripts/install.bat" && .\install.bat

Help⚓︎

Try executing spp-cli --help to output the usage instructions like so:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
Usage: spp-cli [OPTIONS] COMMAND [ARGS]...

Options:
  -v, --verbose            Enable verbose mode
  -p, --platform TEXT      Source++ platform host
  -c, --certificate PATH   Source++ platform certificate
  -k, --key PATH           Source++ platform key
  -a, --access-token TEXT  Developer access token
  -h, --help               Show this message and exit

Commands:
  admin      Administrator commands
  developer  Developer commands
  add        Add live instruments/views
  get        Get live instruments/views
  remove     Remove live instruments/views
  subscribe  Subscribe to live instrument/view events
  version    Display version information

To get information about a sub-command, try spp-cli <command> --help:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
Usage: spp-cli add [OPTIONS] COMMAND [ARGS]...

  Add live instruments/views

Options:
  -h, --help  Show this message and exit

Commands:
  breakpoint  Add a live breakpoint instrument
  log         Add a live log instrument
  meter       Add a live meter instrument
  span        Add a live span instrument
  view        Add a live view subscription
Last update: June 28, 2022