Support & Documentation
Installation guides, tutorials and frequently asked questions.
Installation
🍎macOS (12 Monterey or later)
- Download the .dmg file from the Download page.
- Open the DMG and drag Label Studio Creator.app to your Applications folder.
- First launch: right-click the app → Open to bypass Gatekeeper (unsigned build).
- The app will ask you to activate a license on first use. You can skip this to use the free trial (watermark on exports).
🪟Windows (10 / 11, 64-bit)
- Download the .exe installer from the Download page.
- Run the installer as administrator and follow the wizard.
- Label Studio Creator will be added to your Start menu.
- .rb3l files will automatically open with Label Studio Creator.
🐧Linux (Debian / Ubuntu / RPM)
- Download the .deb (Debian/Ubuntu) or .rpm (Fedora/RHEL) package.
- Install with:
sudo dpkg -i label-studio-creator_*.deb - Or for RPM:
sudo rpm -i label-studio-creator-*.rpm - Launch from the application menu or run
rb3l-label-studioin a terminal.
Getting started
Create your first label
- Go to File → New… and choose a label template (A4 sheets, continuous tape, Zebra, etc.).
- Add objects from the Objects toolbar: text, images, lines, barcodes.
- Drag and resize objects directly on the canvas.
- Save your label as a
.rb3lfile with File → Save.
Using templates
- Open the New Label dialog and browse the built-in template library.
- Templates are organised by manufacturer (Avery, Zebra, DYMO…) and media type.
- You can save your own templates in File → Save as template…
Features guide
Barcodes Barcode plugin
- Click Objects → Insert Barcode… to open the barcode editor.
- Supported formats: EAN-13, EAN-8, Code 128, Code 39, QR Code, DataMatrix, PDF417, ITF-14 and more.
- The barcode value can be a fixed string or a variable field (e.g.
${BARCODE}) linked to a data source. - Requires the Barcode plugin to be included in your license plan.
Data merge (variable data) Datasource plugin
- Open the Merge panel on the right side of the editor.
- Select a data source format: CSV, Excel (.xlsx), JSON, SQLite, ODBC, REST/JSON API, or XML.
- Map column names to label fields using
${FIELD_NAME}syntax. - Preview individual records with the Previous / Next controls.
- When printing, Label Studio Creator will generate one label per row (selected rows only).
Export
- PDF export — File → Export PDF… — requires export-pdf plugin.
- TIFF / PNG export — File → Export TIFF… — requires export-tiff plugin.
- SVG — scalable vector, editable in any vector editor
- ZPL export — File → Export ZPL… — outputs Zebra Programming Language for direct printer streaming. Requires export-zpl plugin.
- EPL2 — direct thermal Zebra legacy printers
- TSPL — TSC and TSPL-compatible thermal label printers
- CPCL — Zebra mobile and CPCL-compatible printers
- SATO SBPL — SATO and SBPL-compatible thermal printers
- RIP Package — File → Export RIP Package… — bundles PDF + ICC profiles + print settings for RIP software. Requires export-rip and export-pdf plugins.
- Separation Proofs — spot/Pantone channel masks (PNG/TIFF + JSON manifest)
- White Plate Proof — white ink and underprint plate (PNG/TIFF + manifest)
- CMYK Plate Proofs — C/M/Y/K grayscale plates with ICC colour management
- Cut Contour â HPGL / G-code cutting paths for Graphtec, Summa and CNC table cutters
Import
- SVG vector files placed as scalable objects
- PDF pages rasterised at up to 600 DPI
Prepress & validation
- Automated preflight: bleed, font size, quiet zones, missing links
- Real-time GS1 barcode validation (GTIN, EAN, SSCC, check digits)
Direct print
- macOS: native CUPS/lp backend (⌘P), AirPrint + USB — includes OKI Pro and Epson ColorWorks
- Windows: native Windows print dialog, all installed printer drivers
- Linux: CUPS/lp backend, all registered printers including network and USB
Automation Automation plugin
- Open Tools → Automation… to configure automated workflows.
- Available triggers: hot folder watch, REST API endpoint, CSV watcher, webhook.
- Actions: auto-print, export to file, run external command, send HTTP request.
- Requires the Automation plugin.
Plugins guide
Each plugin extends Label Studio Creator with additional capabilities. Plugins are unlocked automatically when you activate a license that includes them.
Barcode plugin All plans
Generate 1D and 2D barcodes directly in your labels. Supports all major industrial and retail barcode standards.
How to use
- In the editor, click Objects → Insert Barcode…
- Choose a barcode format from the dropdown (EAN, Code 128, QR Code, DataMatrix…)
- Enter a fixed value, or use a variable field:
${COLUMN}to pull data from a merge source. - Adjust size, quiet zones, and human-readable text display in the properties panel.
- Checksums (EAN-13, UPC, ITF-14) are calculated automatically.
plug_barcode_extra_label
plug_barcode_extra_body
GS1-128 format and enter your Application Identifiers in the value field (e.g. (01)12345678901231(17)261231).Datasource — CSV / TXT All plans
Load variable data from CSV or tab-delimited TXT files. One label per row; column headers map to ${FIELD} variables.
How to use
- Open the Merge panel and select CSV / TXT as the format.
- Click Browse… and select your file. The plugin auto-detects delimiter (comma, semicolon, tab).
- Insert
${COLUMN_NAME}fields in your label to map each column.
Datasource — Excel All plans
Connect to Excel workbooks (.xlsx / .xls). Supports multi-sheet files — choose which sheet to use as the data source.
How to use
- Open the Merge panel and select Excel as the format.
- Click Browse…, select your .xlsx file, then pick the target sheet from the dropdown.
- Column headers (row 1) become the variable names accessible as
${HEADER}in the label.
Datasource — JSON All plans
Load label data from a JSON array. Each element generates one label. Supports flat and nested structures via dot notation.
How to use
- Open the Merge panel and select JSON as the format.
- Click Browse… and select your .json file.
- Map JSON keys to label fields using
${key}— nested keys use dot notation:${order.product}.
[...] for multi-label merge.Datasource — ODBC / SQL All plans
Connect to any ODBC-compatible database (MySQL, PostgreSQL, SQL Server, Access…). Enter a SELECT query to pull records as label data.
How to use
- Install and configure your ODBC driver and DSN via your OS ODBC Manager.
- In the Merge panel, select ODBC and enter your DSN or connection string.
- Type your SQL query. Each row of the result set generates one label.
Datasource — REST API All plans
Fetch label data in real time from any HTTP/REST endpoint. Supports GET and POST with JSON or XML responses.
How to use
- In the Merge panel, select REST API and enter the endpoint URL.
- Set method (GET/POST), optional headers (e.g. Authorization), and a body for POST requests.
- The JSON or XML response is parsed automatically — map keys to label fields with
${key}.
Datasource — SQLite All plans
Query a local SQLite database file directly. Enter a SELECT statement to define which records generate labels.
How to use
- In the Merge panel, select SQLite and browse to your .sqlite file.
- Enter a SQL SELECT query. Each result row produces one label.
- Map column names to label fields with
${column_name}.
Datasource — XML All plans
Load variable data from XML files. Set the repeating record element and map child elements to label fields.
How to use
- In the Merge panel, select XML and browse to your file.
- Set the Record element — the XML tag that repeats per label (e.g.
<product>). - Map child element names to label fields using
${element}.
Export PDF plugin All plans
Print labels to any system printer and export to PDF. Powers the main Print dialog and the RIP Package export.
How to use
- Go to File → Export PDF…
- Choose page layout: single label per page, or multiple labels (sheet layout).
- If a merge source is loaded, select All records (one label per record) or Current record only.
plug_pdf_extra_label
plug_pdf_extra_body
Export TIFF / PNG plugin All plans
Render labels to high-resolution raster images (TIFF or PNG). Useful for archiving, web display, or feeding images into third-party print workflows.
How to use
- Go to File → Export TIFF…
- Select output format: TIFF (multi-page) or PNG (one file per page).
- Set resolution: 72–1200 dpi. For print use, 300 dpi minimum is recommended.
Export ZPL plugin All plans
Generate Zebra Programming Language (ZPL II) code for direct streaming to Zebra label printers. Ideal for industrial label printing without a printer driver.
How to use
- Go to File → Export ZPL…
- Select your target printer resolution: 203 dpi, 300 dpi, or 600 dpi.
- Choose to save as a
.zplfile, or send directly to a printer by IP address (TCP port 9100).
cat label.zpl | nc 192.168.1.100 9100. Variable fields are embedded as ZPL ^FD commands.Export RIP Package plugin All plans
Bundle a print-ready PDF with ICC colour profiles and job ticket settings for RIP Takasaki and compatible RIP software. Required for CMYK+White printing on OKI Pro and Epson ColorWorks printers.
How to use
- Go to File → Export RIP Package…
- Select your printer profile (OKI Pro series, Epson ColorWorks, or custom ICC).
- Enable White channel if your printer supports white ink (OKI Pro1040, Pro1050, Pro9541, Pro9542, Pro8432).
.zip to inspect its contents.Automation — Hot Folder All plans
Monitor a folder for incoming data files. When a file drops in, labels print automatically — zero clicks required.
How to use
- Open Automation → Hot Folder… and set the watched folder path.
- Select the label template and target printer to use when a file arrives.
- Drop a data file into the folder — labels print immediately and the file moves to an archive subfolder.
Automation — Command Line (CLI) All plans
Print labels from shell scripts, cron jobs, or any automation pipeline using the rb3l-print CLI tool bundled with the app.
How to use
- Locate the CLI:
Label Studio Creator.app/Contents/MacOS/rb3l-printon macOS, or add it to your PATH on Windows/Linux. - Run:
rb3l-print --label template.rb3l --data records.csv --printer "My Printer" - Use
--qty Nfor copies,--dry-runto validate without printing.
cron or Windows Task Scheduler for scheduled label printing.Automation — REST API Server All plans
Starts a local HTTP server that exposes a REST endpoint. External apps, ERPs, or web services POST JSON to trigger label printing.
How to use
- Enable under Automation → REST API… and choose a port (default: 8765).
- Send:
POST http://localhost:8765/printwith a JSON body specifying label, data, and printer. - The API returns a JSON response with job status and any errors.
Automation — CSV Watcher All plans
Monitor a CSV file for appended rows. Each new row automatically triggers label printing — ideal for PLC or SCADA integration.
How to use
- Open Automation → CSV Watcher… and point it to your production CSV file.
- Set the polling interval (1–60 s), label template, and target printer.
- When new rows are appended, labels print automatically for each new record.
Automation — Webhook All plans
Receive HTTP webhook events (POST JSON) from Shopify, WooCommerce, or any external platform to trigger label printing on demand.
How to use
- Enable under Automation → Webhook… and note the local endpoint URL.
- Configure your platform to send order webhooks to this URL.
- Map the webhook JSON fields to label variables — labels print automatically when an event arrives.
Printer calibration plugin All plans
Fine-tune colour output for specific printer and media combinations. Import ICC profiles, adjust colour channels, and create soft proofs before printing.
How to use
- Go to Tools → Printer Calibration…
- Select your printer and media type from the list.
- Click Import ICC profile… to load a manufacturer-supplied or custom ICC profile.
- Use the Colour adjustment sliders (brightness, contrast, saturation, per-channel curves) to fine-tune output.
- Click Soft proof to preview on screen how the label will look printed with the selected profile.
- Save as a named calibration preset — it will be available in the Print and RIP Export dialogs.
SVG Export All plans
Export labels as resolution-independent vector SVG — ideal for digital workflows, web preview and laser cutting.
How to use
- Go to File → Export → Export SVG…
- Choose export options: embedded fonts, artboard size, unit (mm/px/pt).
- Click Export. Spot colours and gradients are preserved as SVG named elements.
EPL2 Export All plans
Generate Eltron Programming Language 2 (EPL2) output for direct thermal Zebra legacy printers.
How to use
- Go to File → Export → Export EPL2…
- Select target DPI (203 or 300) and darkness (0–15).
- Click Export. Send the .epl file directly to the printer via USB/serial or network.
Import SVG All plans
Import SVG vector artwork directly into the label editor. Preserves paths, groups, fills, strokes and text.
How to use
- Go to File → Import → SVG… and select your file.
- The SVG is placed as a vector layer on the canvas — resize and position freely.
- Spot colours defined with
fill="spot:NAME"are automatically mapped to the spot colour palette.
Import PDF All plans
Import a PDF page as a vector artwork layer. Ideal for placing existing label designs or client-supplied artwork.
How to use
- Go to File → Import → PDF… and select your file.
- For multi-page PDFs, choose which page to import.
- The PDF is embedded as a vector layer — add variable fields and barcodes on top.
Print Backend (macOS) All plans
Native macOS print backend using CUPS/lp for direct printing to any AirPrint or USB printer without leaving Label Studio Creator.
How to use
- Go to File → Print… (or ⌘P).
- Select your printer from the list. All CUPS-registered printers and AirPrint devices are detected automatically.
- Set quantity, collation and colour mode, then click Print.
Prepress Validation All plans
Automated preflight checks: bleed, minimum font size, barcode quiet zones, colour space consistency and missing links — before sending to print or RIP.
How to use
- Go to Tools → Prepress Validation…
- The checker runs instantly and flags issues with severity: Error (blocks export) or Warning (advisory).
- Checks include: bleed margins, minimum font size (default 6 pt), barcode quiet zones, out-of-gamut spot colours, empty variable fields.
- Click any issue in the list to jump directly to the offending object on the canvas.
Barcode Validation All plans
GS1-compliant barcode validation engine: check digits, AI structure, GTIN/EAN/UPC/SSCC formats, date codes, and quiet-zone compliance.
How to use
- Validation runs in real time as you type in the barcode data field — a green tick or red warning appears instantly.
- Go to Tools → Barcode Validation… for a full report across all barcodes on the label.
- Checks: GS1 Application Identifiers (AIs), check digits (Luhn, GS1, ISBN), SSCC-18 structure, mandatory quiet zones.
TSPL Export All plans
Exports label documents to TSPL/TSPL2 raster BITMAP commands for TSC and TSPL-compatible thermal label printers.
How to use
- Go to File → Export → Export TSPL…
- Select target DPI (203, 300 or 600) and print speed.
- Click Export. Send the .tspl file via USB or network to the printer.
CPCL Export All plans
Exports label documents to CPCL raster commands for Zebra mobile and CPCL-compatible thermal label printers.
How to use
- Go to File → Export → Export CPCL…
- Select target DPI and page orientation.
- Click Export. Send the .cpcl file to the printer via Bluetooth or USB.
SATO SBPL Export All plans
Exports label documents to SATO SBPL raster graphic commands for SATO and SBPL-compatible thermal label printers.
How to use
- Go to File → Export → Export SBPL…
- Select target DPI (203 or 305) and media type.
- Click Export. Send the .sbpl file to the SATO printer via USB, serial or LAN.
Separation Proof Export All plans
Exports spot/Pantone separation proof masks as grayscale PNG or TIFF files with a JSON manifest for RIP preflight.
How to use
- Go to File → Export → Export Separation Proofs…
- Select output format (PNG or TIFF) and resolution (300–1200 DPI).
- Click Export. One grayscale file per spot/Pantone channel is generated, plus
manifest.json. - The manifest lists each channel name, its file path, and whether it is a spot or Pantone colour.
White Plate Proof Export All plans
Exports the white ink and underprint plate as a grayscale PNG or TIFF proof with a JSON manifest for RIP preflight.
How to use
- Go to File → Export → Export White Plate Proof…
- Select output format (PNG or TIFF) and resolution.
- Click Export. The white plate mask and a
manifest.jsonare generated.
CMYK Plate Proof Export All plans
Exports C, M, Y, K grayscale plate proofs using ICC/LittleCMS colour management when ICC profiles are provided.
How to use
- Go to File → Export → Export CMYK Plate Proofs…
- Select ICC profile for colour-managed conversion or use direct CMYK values.
- Select resolution (300–1200 DPI) and click Export. Four grayscale PNG/TIFF files are generated — one per channel.
CUPS Print Backend All plans
Linux/macOS CUPS print backend for submitting PDF, TIFF and PNG jobs through lp/lpstat. Works with network printers and RIP Takasaki label server.
How to use
- Go to File → Print… and select a CUPS printer from the list.
- All printers registered in CUPS (USB, network, AirPrint) are automatically discovered.
- Set quantity and colour mode, then click Print. Jobs are submitted via
lpand tracked withlpstat.
Epson ColorWorks Backend All plans
Print backend for Epson ColorWorks printers (C3500, C6000, C7500, C831) through the official operating-system driver and CUPS/lp for colour label production.
How to use
- Install the Epson ColorWorks driver for your model (C3500, C6000, C7500, or C831).
- Go to File → Print… and select your Epson ColorWorks from the printer list.
- Select colour mode and media profile, then click Print. Jobs are routed through the official Epson CUPS driver.
Color/RIP Audit All plans
Audits ICC/LittleCMS availability, optional ICC profiles, spot separations, white ink and underprint metadata before RIP package output.
How to use
- Go to Tools → Color/RIP Audit…
- The audit checks: LittleCMS engine availability, loaded ICC profiles, spot/Pantone colour assignments, white ink metadata and underprint settings.
- Issues are listed with severity — Error (blocks RIP export) or Warning (advisory).
Ink Coverage Audit All plans
Audits CMYK total area coverage (TAC), white plate coverage and spot/Pantone coverage for RIP preflight and ink cost estimation.
How to use
- Go to Tools → Ink Coverage Audit…
- The audit computes per-channel ink coverage percentages: C, M, Y, K, White, and each spot colour.
- Total Area Coverage (TAC) is reported and flagged if it exceeds the configured limit (default 320%).
Cut Contour Export plugin All plans
Export label sheet cut contours for plotter cutting and finishing workflows â HPGL, G-code, or SVG cutline format. Compatible with Graphtec, Summa, and CNC table cutters.
How to use
- Design your label with a cut contour layer named Cut or CutContour.
- Go to File â Export Cut Contourâ¦
- Select output format: HPGL (Graphtec, Summa pen plotters), G-code (CNC table cutters), or SVG cutline.
E-commerce Connectors plugin All plans
Route Shopify and WooCommerce orders automatically into proof approval or production-ready print queues. SKU-to-template mapping â no manual steps.
How to use
- Go to Tools â E-commerce Connectors⦠and connect your Shopify or WooCommerce store.
- Map each product SKU to a label template file.
- Set the default routing: Proof approval (BAT before print) or Production ready (auto-print).
- New orders are received automatically and queued â no manual intervention required.
Cloud Proof Approval plugin All plans
Send a digital proof to your customer for remote approval before printing. Draft, Sent, Approved, Rejected, and Expired queues with full audit trail.
How to use
- After label design, click Proof â Send for Approvalâ¦
- Enter the customer email â a secure proof link is sent automatically.
- Track status in the Proof Queue: Draft â Sent â Approved or Rejected.
- Approved proofs are released to the production queue automatically.
Production Inventory plugin All plans
Track roll and media consumption for short-run label production. Estimates consumed length per job and raises reorder alerts when stock is low.
How to use
- Open Tools â Inventory⦠to register your media rolls and stock levels.
- Each print job automatically deducts the consumed media length.
- Set reorder thresholds per media type â alerts appear when stock drops below the limit.
OKI Calibration Tool plugin All plans
Guided calibration workflows for OKI Pro printers: print position calibration, ink density targets, and white ink spread/choke adjustment.
How to use
- Go to Tools â OKI Calibrationâ¦
- Print the position calibration target and enter the offset values measured on your printout.
- Use the density calibration chart to adjust ink density per channel.
- The white spread/choke slider adjusts white underprint expansion for better opacity on transparent media.
Template & Asset Library plugin All plans
A collection of industry-ready label templates and reusable object catalog. Browse, preview, and insert directly into the editor.
How to use
- Open File â New from Template⦠or Objects â Asset Libraryâ¦
- Filter by industry: food & beverage, logistics, retail, pharmaceuticalâ¦
- Select a template and click Open â pre-configured with correct dimensions, bleed, and safe zones.
Production Queue Audit All plans
Audits Label Server and hotfolder production queues: stale processing jobs, error queues, retry/reprint folders and JSONL production logs.
How to use
- Go to Tools → Production Queue Audit… or run from Label Server mode.
- The audit scans automation incoming/processing/done/error queues and print-spool queues.
- Stale jobs (stuck in processing beyond timeout) are flagged. Error queue contents are listed with timestamps and job IDs.
- Click Retry to move a failed job back to incoming, or Cancel to archive it to error with a reason.
Print Backend (Windows) All plans
Native Windows GDI/WPF print backend. Enables direct printing to any Windows-installed printer — no CUPS or third-party spooler required.
How to use
- On Windows the backend activates automatically. All printers installed in Windows appear in File → Print….
- Select your printer and page size. Driver settings (tray, duplex, quality) are accessible via Printer Properties.
- For Zebra or Honeywell printers, install the manufacturer driver to unlock label-specific settings (DPI, darkness, media).
Epson ColorWorks Printer All plans
Direct hardware control for Epson ColorWorks C-series inkjet label printers. Enables CMYK ink management and media-specific colour profiles.
How to use
- Connect your Epson ColorWorks via USB or network and install the Epson driver.
- In Preferences → Printers, select Epson ColorWorks mode to unlock ink and media controls.
- Load the ICC profile for your printer/media combination from the colour profile panel.
External RIP Integration All plans
Hand off labels to third-party RIP software (Wasatch, Caldera, ErgoSoft, ONYX…) via PDF/X-4 or PostScript with embedded ICC profiles and spot colour channels.
How to use
- Configure the RIP hotfolder path under Preferences → External RIP….
- Choose output format: PDF/X-4 (recommended) or PostScript.
- Print to the External RIP destination — the file is saved to the RIP hotfolder and processed automatically.
Plugin SDK — HelloWorld All plans
A minimal example plugin demonstrating the Plugin SDK API. Use it as a starting point to build custom plugins for Label Studio Creator.
How to use
- Find the source in
plugins/helloworld/in the SDK repository. - Build with CMake:
cmake --build . --target helloworld. - Load the built
.pluginbundle via Help → Developer → Load Plugin….
License & activation
Activate your license
- Go to Help → License… in the application menu.
- Enter your license key (format:
XXXX-XXXX-XXXX-XXXX). - Click Activate. The app will contact the license server to validate and download your enabled plugins.
- On success, the licensed features unlock immediately — no restart needed.
What happens when the license expires?
- The application continues to work normally for editing.
- The app enters trial mode: all features remain usable but a "Label Studio Creator — TRIAL" watermark appears on every export and print output.
- Your label files and data are never deleted — renewing your license removes the watermark instantly.
- To restore full access, renew your license in your customer account.
Multiple seats & computers
- Each license key includes a fixed number of seats (activations).
- You can activate on multiple machines up to your seat limit.
- To free a seat (e.g. after replacing a computer), go to My Account → Manage seats and revoke the old activation.
FAQ
Contact & support
Email support
For technical issues, billing questions or feature requests, send us an email:
Send an emailBug reports & feature requests
Open a GitHub issue for bugs, unexpected behaviour or feature suggestions.
Open an issue on GitHubManage your license
View your licenses, seats and billing history in your customer account.
Go to My Account
Label Studio Creator