Skip to content

Repository files navigation

thermal-label-cli

Unified CLI for thermal label printers. Auto-detects every installed driver — Brother QL, DYMO LabelWriter, DYMO LabelManager, and any future driver built against @thermal-label/contracts.

npm version CI License: MIT

Install

# CLI plus the driver(s) for your printer:
npm install -g thermal-label-cli @thermal-label/brother-ql-node
Printer family Driver package
Brother QL @thermal-label/brother-ql-node
DYMO LabelWriter @thermal-label/labelwriter-node
DYMO LabelManager @thermal-label/labelmanager-node

Quick example

thermal-label list                       # detect connected printers
thermal-label status                     # readiness + media + errors
thermal-label print text "Hello World"   # quick text print
thermal-label print image logo.png       # PNG / JPEG print
thermal-label print text "hi" --host 192.168.1.67          # network printer, driver auto-picked
thermal-label print text "hi" --host 192.168.1.67 --device QL_820NWBc --media 251   # when it cannot identify itself

Network printers show up in list when the driver can find them on the LAN (Brother QL: SNMP broadcast); --host reaches the ones it cannot. --device <key> and --media <id> take over when identification or media detection is not possible.

Documentation

Full docs at https://thermal-label.github.io/cli/.

  • Command + flag reference
  • Network printers: --host, --device, --media, --community
  • thermal-label-cli vs burnmark-cli — when to use which

Philosophy

Diagnostic-first: prove cabling, USB permissions, TCP connectivity; smoke-test media detection and error reporting; script one-off prints in CI or systemd units. For templates, barcodes, CSV batches, and sheet PDFs, see burnmark-cli — same drivers, production-oriented workflow.

Compatibility

Runtime Node ≥ 20.9 (Node 24 LTS recommended)
Drivers Auto-detects any installed @thermal-label/*-node driver with a discovery export
License MIT

Contributing

See CONTRIBUTING/ on the org .github repo.

About

Unified CLI for thermal label printers — auto-detects all installed drivers

Resources

Code of conduct

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages