Skip to main content

Command-Line Tools

There are several included tools that can be used to manage the VidRedi system.

VidRedi is designed to run headless (without a GUI). The Blackmagic Desktop Video package does not include CLI tools to manage the card, so VidRedi ships a small wrapper around the bmd-node package.

# Show the help
/opt/vidredi/current/scripts/decklink-cli.js

# List devices, duplex mode, and SDI level
/opt/vidredi/current/scripts/decklink-cli.js devices

# Read and set SDI level
/opt/vidredi/current/scripts/decklink-cli.js get -d 0 -p sdi-level
/opt/vidredi/current/scripts/decklink-cli.js set -d 0 -p sdi-level -v A

# Read card temperature
/opt/vidredi/current/scripts/decklink-cli.js get -d 0 -p temperature

Firmware updater​

The Desktop Video package includes BlackmagicFirmwareUpdater. The DeckLink card will not work if its firmware does not match the installed driver.

See Troubleshooting for firmware status and update commands.

VidRedi CLI​

The management CLI can read system configuration values stored in the database. Run it from the installed application:

# List all configuration keys and values
/opt/vidredi/current/server/dist/cli.js config list

# Read one key
/opt/vidredi/current/server/dist/cli.js config read deviceName

Use this when you need a value from a shell session. Day-to-day changes belong on Configuration → System in the web interface.