https://github.com/tigitz/pupprinteer
Effortless HTML to PDF/PNG as a Standalone Binary - Powered by Puppeteer
https://github.com/tigitz/pupprinteer
Last synced: 5 months ago
JSON representation
Effortless HTML to PDF/PNG as a Standalone Binary - Powered by Puppeteer
- Host: GitHub
- URL: https://github.com/tigitz/pupprinteer
- Owner: tigitz
- Created: 2024-12-29T01:48:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-29T06:30:59.000Z (over 1 year ago)
- Last Synced: 2025-02-12T09:08:02.317Z (over 1 year ago)
- Language: TypeScript
- Size: 132 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pupprinteer
A standalone binary tool that bundles Puppeteer and Chrome Headless for converting HTML to PDF without external dependencies.
## Features
- Single binary distribution - no need to install Node.js, Chrome, or any other dependencies
- Supports both local HTML files and remote URLs as input
- Bundled Chrome Headless browser
- Customizable PDF output settings
- Cross-platform support (Windows, Linux, macOS)
- Detailed logging options
## Installation
Download the latest release for your platform from the [releases page](https://github.com/keesystem/pupprinteer/releases).
The binary is self-contained and requires no additional installation steps.
## Usage
Basic usage:
```bash
./pupprinteer -f input.html -o output.pdf
```
Converting a URL to PDF:
```bash
./pupprinteer -f https://example.com -o example.pdf
```
### Options
Required:
- `-f, --file ` - Path to local HTML file or remote URL to convert
Optional:
- `-o, --output ` - Destination path where the PDF file will be saved
- `-v, --verbose` - Enable detailed debug logging output
- `-e, --chrome-executable ` - Custom Chrome browser executable path
- `-t, --timeout ` - Additional time to wait after page load completes
- `-p, --pdf-settings ` - Base PDF settings as JSON (will be overridden by specific options)
PDF Settings Options:
- `--scale ` - Scale of the webpage rendering
- `--displayHeaderFooter` - Display header and footer
- `--headerTemplate ` - HTML template for the print header
- `--footerTemplate ` - HTML template for the print footer
- `--printBackground` - Print background graphics
- `--landscape` - Paper orientation
- `--pageRanges ` - Paper ranges to print (e.g., "1-5, 8, 11-13")
- `--format ` - Paper format (letter, legal, tabloid, ledger, a0-a6)
- `--width ` - Paper width, accepts values labeled with units
- `--height ` - Paper height, accepts values labeled with units
- `--preferCSSPageSize` - Give any CSS @page size declared in the page priority
- `--margin ` - Paper margins, format: "top,right,bottom,left" in pixels or with units
- `--omitBackground` - Hide default white background
## How It Works
Pupprinteer bundles Chrome Headless Shell (a minimal version of Chrome optimized for automation) directly into the binary during the build process. When executed, it:
1. Extracts the bundled Chrome binary to your system's temporary directory
2. Uses this extracted Chrome instance with Puppeteer to generate PDFs
3. Automatically manages the Chrome binary lifecycle
## Continuous Integration & Releases
The project uses GitHub Actions for automated builds and releases:
- Every commit to the `main` branch triggers a new build
- Successful builds automatically create GitHub releases
- Platform-specific binaries are attached as release assets:
- Windows (x64)
- Linux (x64)
- macOS (x64 & ARM64)
## Building from Source
Requirements:
- [Bun](https://bun.sh/) runtime
Clone and build:
```bash
# Clone the repository
git clone https://github.com/yourusername/pupprinteer.git
cd pupprinteer
# Install dependencies
bun install
# Download Chrome Headless Shell
bun run build/chrome-download.ts
```
# Build for your platform
Windows:
```bash
bun build --compile --target=bun-windows-x64-modern --minify --sourcemap src/main.ts --outfile pupprinteer.exe
```
Linux:
```bash
bun build --compile --target=bun-linux-x64-modern --minify --sourcemap src/main.ts --outfile pupprinteer
```
The build process:
1. Downloads the appropriate Chrome Headless Shell version
2. Bundles it with the application code
3. Creates a self-contained binary for the target platform