bsc - BrightSign CLI for DWS

The BrightSign CLI tool bsc is the command line interface for interacting with the Diagnostic Web Server (DWS).

This is the second version of bsc, with the deprecated code being found here. This code contains breaking changes, so update with caution.

Install the CLI

It is recommended to install the CLI through the npm package manager, which comes bundled with Node.js when installed on your system.

With npm installed, we recommend bsc to be installed and upgraded globally:

npm install --global @brightsign/bsc

Getting Started

Add a player to bsc with:

bsc local player --add

storing information in ~/.bsc/players.json.

Note: If you have not used bsc before, you must generate the players.json file (for now). Run:

touch ~/.bsc/players.json

Then, add your first player with:

bsc local player --add --player playerName --ip ip-address --user username --pass password --storage sd | ssd | usb

From here, the supported commands can be seen by running, bsc or bsc --help.

To get started with your first interactive command, try to retrieve your player's info:

bsc info --player PLAYER_NAME

NOTE: This CLI will have multiple nested command-spaces (such as cloud features), but for now there is only one: local. You must namespace into this field to use the commands: bsc local ....

TIP: Adding --help after any command will provide additional information on how to use that command.

Filepath Naming Convention

Many commands require either a filePath or a location parameter to be passed in. When we refer to a file on the player, or any path locally (file or directory), this is filePath. When referring to a directory on the player, this is location.

To upload a file, for example:

bsc local file --upload --player playerName --file ./path-to-your-file --destination sd/path-on-player

Note that the --destination option is optional, and without it the file will be uploaded to the root of the SD card. Also note that you can upload directories or files with --file.