@brightsign/bsc

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.

Table of Contents

• Install the CLI
• Getting Started
  • Configure Credentials
  • Add a Player
• Filepath Naming Convention
• Local Development
  • Initial Setup
  • Development Workflow

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

Configure Credentials

Before using most commands, you need to configure your BrightSign credentials. You can do this in one of two ways:

1. Run the configuration wizard:

bsc configure

2. Set the following environment variables:

# Required
BRIGHTSIGN_CLIENT_ID=your_client_id
BRIGHTSIGN_CLIENT_SECRET=your_client_secret

# Optional - specify one of these as a default
BRIGHTSIGN_NETWORK_NAME=your_network_name
BRIGHTSIGN_NETWORK_ID=your_network_id

Add a Player

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

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.

Key Features

• Player Management: Add, list, and remove BrightSign players.
• File Operations: Upload, download, delete, and list files.
• Registry Management: Get, set, and delete registry entries.
• System Information: Retrieve player information, including hardware details, network configuration, and system status.
• Power Management: Reboot, reset, and control player power state.
• Screenshot Capture: Take screenshots from connected players.

Requirements

• Node.js 20.11.1 or later
• Network connectivity to your BrightSign player
• DWS enabled on your BrightSign player

Contributing

We welcome contributions! Please see our CONTRIBUTING.md for guidelines on how to get started developing bsc.

License

MIT License - See LICENSE file for details.