PrintLinkPrintLink user docs
Everything you need to put printing into your business app: install the Agent, print and preview from a web page, integrate the SDK, the API reference, deployment, operations and troubleshooting.
Last updated
PrintLink is a print service (the print Agent) installed on the computer with your printers. Business apps call it directly to put paper out: silent printing, a preview window, and printing to the printer's real capabilities — with no browser print dialog and no plug-in.
<script src="http://127.0.0.1:17888/sdk/printlink.js"></script>
<script type="module">
const client = new PrintLink.PrintLinkClient({ appName: 'My business app' });
await client.connect();
await client.ensureAuthorized(); // the local user confirms once
const { queues } = await client.listPrinters();
await client.compose({ queueId: queues[0].queueId }).addPdf(pdfBytes).printAndWait();
</script>A complete runnable example is in the quick start.
Getting started
What is PrintLink
The problem it solves, what it can print, where it runs and on which systems.
Install
Download the package, confirm the service, change the port, common problems.
Quick start
Five steps to your first page, with a full copy-paste example.
Core features
Organised by what you are trying to do. Each page covers how to use it and the pitfalls worth knowing.
Print silently, wait for the result, cancel and list jobs.
Preview
Let the user confirm before paper comes out, and adjust paper or layout in the window.
Print options
Copies, paper, duplex, colour, quality, media type.
Printers & profiles
Pick a printer, read live status and real capabilities, save reusable settings.
Scan
List scanners, start a scan, confirm on the desktop and fetch the pages.
Integration
How to integrate
Script tag, npm, React and Vue 3, plus lifecycle handling.
Content sources
PDF, images, templates and web pages — and which to choose.
Composite jobs
Mix sources in one job: one preview, one print, one sheet.
Hiprint templates
Migrate existing vue-plugin-hiprint templates and what converts.
API reference
API overview
Every method for connecting, authorising, printing, previewing, printers and scanning.
Events
Live notifications for job progress, printer status and authorisation.
Permissions
What each method requires, how to request it, how it gets revoked.
Error codes
Every error code, what it means and whether retrying helps.
HTTP interface
For mobile apps and servers that cannot hold a WebSocket open.
Deployment & operations
Deployment topology
When the printer is not on the user's computer: LAN or remote?
LAN print workstation
One machine holds the printers, several share the output.
Controlled remote access
VPN or reverse proxy: what applies and who is responsible.
Security
Who may connect, what they can do, and how to take it back.
Troubleshooting
Nothing prints, it hangs, or the layout is wrong — what to check first.
Logs & log bundle
Log settings, disk budget and exporting a bundle for support.
Enterprise deployment
Silent installation, machine policy and central management.
Tools & support
Online designer
Design mm-precision templates without code.
Playground
A protocol-level debug console against the local Agent.
Examples
Runnable examples covering every print source.
FAQ
The dozen questions that come up most.
About these docs
- Every page has Copy page (Markdown) and Copy for AI at the top: the latter adds the title, URL and last-updated date so you can paste it into an AI assistant and get integration code grounded in the official docs.
- Every page shows its last updated date.
- When something goes wrong, start with the FAQ and troubleshooting, then the error codes; export a log bundle when you need someone else to look.