CLI Quick Reference

All commands at a glance

Commands

Command Description
bptimecode serve Start the BPTimecode server
bptimecode slot list List all timecode slots
bptimecode slot create --name <name> Create a new slot
bptimecode slot delete <ref> Delete a slot
bptimecode slot play <ref> Start playback
bptimecode slot pause <ref> Pause playback
bptimecode slot stop <ref> Stop playback
bptimecode slot reset <ref> Reset to 00:00:00:00
bptimecode slot jump <ref> <tc> Jump to timecode
bptimecode slot info <ref> Show slot details
bptimecode preset list <slot> List presets for a slot
bptimecode preset create <slot> <name> <tc> Create a preset
bptimecode preset delete <slot> <name> Delete a preset
bptimecode preset trigger <slot> <name> Jump to preset
bptimecode route list Show routing matrix
bptimecode route set <slot> <dest> Route slot to destination
bptimecode route clear <slot> <dest> Remove a route
bptimecode device list List all devices
bptimecode device add <name> --type <type> Add a device
bptimecode device remove <name> Remove a device
bptimecode device health Show device health
bptimecode config show Display current config
bptimecode config path Show config file path
bptimecode config reset Reset to defaults

Global Options

Option Description
--port, -p <port> HTTP server port (default: 5050)
--osc-port <port> OSC server port (default: 5051)
--config, -c <path> Config file path
--verbose, -v Enable verbose output
--help, -h Show help
--version Show version

Slot References

Commands accepting <ref> accept:

  • Number — 1-indexed position (e.g., 1)
  • ID — Internal unique ID
  • Name — Quoted name (e.g., "Main TC")

Timecode Format

HH:MM:SS:FF — e.g., 01:30:00:00

Frame Rates

23.976 24 25 29.97 29.97df 30 50 59.94 60

For detailed usage and examples, see Full CLI Documentation.