BrightSign CLI Commands

A collection of reusable, composable commands for the BrightSign CLI, supporting both local and remote device management. This package is designed for integration into CLI applications and scripts that interact with BrightSign digital signage players.

Features

• Local and remote device management
• File operations (upload, download, delete)
• Device info, logs, and registry access
• Player configuration and password management
• Time, screenshot, and reboot commands
• Extensible command structure using commander

Installation

This package is intended for use within the BrightSign Actions monorepo and is managed via pnpm workspaces.

pnpm install @brightsign/cli-commands

Usage

Import and register commands in your CLI application:

import { configureCommand } from '@brightsign/cli-commands';
import { Command } from 'commander';

const program = new Command();
program.addCommand(configureCommand);
// Add other commands as needed
program.parse(process.argv);

Example: Configure Credentials

bsc configure

Follow the prompts to enter your BrightSign API credentials.

API Structure

• configureCommand: Prompts for and saves API credentials
• players: Player management commands
• networks: Network management commands
• local/remote: Namespaces for local and remote device operations

See the documentation for a full API reference and command list.

Development

• Requires Node.js >= 20.11.1 and pnpm
• Build: pnpm build
• Lint: pnpm lint
• Test: pnpm test