mirror of
https://github.com/anikeen-com/print-utils.git
synced 2026-03-13 13:46:07 +00:00
90 lines
1.4 KiB
Markdown
90 lines
1.4 KiB
Markdown
# Print Utils
|
|
|
|
## Description
|
|
|
|
This is a [Sendcloud](https://www.sendcloud.com) compatible Print Client which runs on Windows, Linux and Mac. Its goal
|
|
is providing a simple and easy to use interface to print documents from any application to a printer connected to the
|
|
computer.
|
|
|
|
## Installation
|
|
|
|
### Clone the repository
|
|
|
|
```bash
|
|
git clone http://github.com/bitinflow/print-utils.git
|
|
```
|
|
|
|
### Install dependencies
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
### Install pm2
|
|
|
|
```bash
|
|
npm install pm2 -g
|
|
```
|
|
|
|
### Start the server
|
|
|
|
Start and add a process to the pm2 process list:
|
|
|
|
```bash
|
|
pm2 start index.js --name print-utils
|
|
```
|
|
|
|
Stop, start and restart a process from the process list:
|
|
|
|
```bash
|
|
pm2 stop print-utils
|
|
pm2 start print-utils
|
|
pm2 restart print-utils
|
|
```
|
|
|
|
## Usage
|
|
|
|
### List Printers
|
|
|
|
#### Request:
|
|
|
|
```bash
|
|
curl --location 'http://127.0.0.1:1903/printers'
|
|
```
|
|
|
|
#### Response:
|
|
|
|
> The `default` property is currently always `false` because the default printer is not yet supported.
|
|
|
|
```json
|
|
[
|
|
{
|
|
"default": false,
|
|
"format": "PDF",
|
|
"id": "PM-241-BT (Network)",
|
|
"name": "PM-241-BT (Network)"
|
|
}
|
|
]
|
|
```
|
|
|
|
### Print a PDF
|
|
|
|
#### Request:
|
|
|
|
```bash
|
|
curl --location 'http://127.0.0.1:1903/printers/PM-241-BT%20(Network)/print' \
|
|
--form 'file=@"label.pdf"' \
|
|
--form 'copies="1"'
|
|
```
|
|
|
|
#### Response:
|
|
|
|
> On windows the response does not return any real job id. Instead, it returns a 0.
|
|
|
|
```json
|
|
{
|
|
"jobs": [
|
|
"1"
|
|
]
|
|
}
|
|
``` |