README.md

What is this?

This project provides a command-line interface to Source++, the continuous feedback platform for developers.

Install

Linux or macOS

Install the latest version with the following command:

/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.

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

Install by available binaries

Go to the releases page to download all available binaries, including macOS, Linux, Windows.

How to use?

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

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, --authorization-code TEXT  Developer authorization code
  -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

Documentation

• Developer Commands
• Admin Commands

Bugs & Features

Bug reports and feature requests can be created here.