README
¶
pdfcpu: PDF tooling for Go and the command line
pdfcpu is a PDF processing library and command-line tool written in Go. It supports validation, optimization, encryption, signing, document assembly, content extraction, and other common PDF operations.
pdfcpu supports PDF versions through PDF 2.0 (ISO 32000-2). PDF 2.0 validation support is basic and continuously improving.
Horst Rutter, the maintainer of pdfcpu, is a member of the PDF Association.
Installation
| Command-line interface | Go API |
|---|---|
| CLI Installation instructions | API Installation instructions |
Usage
CLI
Validate a PDF:
pdfcpu validate input.pdf
Merge two PDFs:
pdfcpu merge merged.pdf in1.pdf in2.pdf
Go API
See API documentation for usage examples.
Features
- Validate, optimize, split, trim, and merge PDFs
- Extract and manipulate images, fonts, and metadata
- Encrypt and decrypt PDFs
- Resize and rotate pages
- Add and remove stamps and watermarks
- Validate signature integrity, report signature evidence, and remove signatures
- Manage attachments and portfolios
Examples
Selected examples:
Commands
Complete list of supported commands:
Motivation
pdfcpu aims to provide comprehensive PDF processing capabilities implemented in Go for both individual files and automated batch processing.
It focuses on correctness, robustness and independence from external dependencies.
Focus
- comprehensive PDF processing functionality
- minimal external dependencies
- predictable and stable behavior
Documentation
- Project documentation: https://pdfcpu.io
- Changelog: https://pdfcpu.io/changelog
- Contributing guidelines
- Security policy
CLI
- Command help:
pdfcpu [command] --help
Go API
-
Package documentation: https://pkg.go.dev/github.com/pdfcpu/pdfcpu
-
API documentation: https://pkg.go.dev/github.com/pdfcpu/pdfcpu/pkg/api
-
Examples:
Contributing
Contributions are welcome. See the contributing guidelines and the complete list of contributors.
Reporting PDF issues
For triage, we use Adobe Acrobat Reader and macOS Preview as practical compatibility references.
Reports are especially helpful when a PDF opens in either application but cannot be processed by pdfcpu, as these cases may
reveal opportunities to improve validation or parser compatibility.
If neither application can open the PDF, it is unlikely that pdfcpu will be able to process it reliably.
Start by validating the file:
pdfcpu validate -vv <file.pdf>
Include the command, its verbose output, and a sample PDF with the report.
Please submit only files that you have permission to share and that contain no confidential information or personal data.
Security
Please do not report security vulnerabilities through public GitHub issues.
See the security policy for private reporting instructions.
Code of Conduct
This project is released with a Contributor Code of Conduct. By participating, you agree to abide by its terms.
Disclaimer
Use of pdfcpu assumes compliance with all applicable copyrights for any processed PDF content, including embedded resources such as fonts and images.
Gopher artwork by Renee French
License
Apache License 2.0
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pdfcpu
command
Package main provides the command line for interacting with pdfcpu.
|
Package main provides the command line for interacting with pdfcpu. |
|
internal
|
|
|
contextutil
Package contextutil provides shared checks for required Go contexts.
|
Package contextutil provides shared checks for required Go contexts. |
|
corefont/metrics
Package metrics provides font metrics for the PDF standard fonts.
|
Package metrics provides font metrics for the PDF standard fonts. |
|
fileutil
Package fileutil provides internal cross-platform filesystem operations.
|
Package fileutil provides internal cross-platform filesystem operations. |
|
inputlimit
Package inputlimit provides fixed limits for non-PDF input consumed by pdfcpu.
|
Package inputlimit provides fixed limits for non-PDF input consumed by pdfcpu. |
|
netutil
Package netutil provides address checks for outbound HTTP requests.
|
Package netutil provides address checks for outbound HTTP requests. |
|
pkg
|
|
|
api
Package api lets you integrate pdfcpu's operations into your Go backend.
|
Package api lets you integrate pdfcpu's operations into your Go backend. |
|
cli
Package cli provides pdfcpu command line processing.
|
Package cli provides pdfcpu command line processing. |
|
filter
Package filter contains PDF filter implementations.
|
Package filter contains PDF filter implementations. |
|
font
Package font provides support for TrueType fonts.
|
Package font provides support for TrueType fonts. |
|
log
Package log provides a logging abstraction.
|
Package log provides a logging abstraction. |
|
pdfcpu
Package pdfcpu is a PDF processing library written in Go supporting encryption.
|
Package pdfcpu is a PDF processing library written in Go supporting encryption. |
|
pdfcpu/color
Package color provides PDF color types and parsing utilities.
|
Package color provides PDF color types and parsing utilities. |
|
pdfcpu/create
Package create generates PDF documents from declarative descriptions.
|
Package create generates PDF documents from declarative descriptions. |
|
pdfcpu/draw
Package draw writes PDF drawing primitives and table separators.
|
Package draw writes PDF drawing primitives and table separators. |
|
pdfcpu/fault
Package fault classifies recoverable PDF conformance faults.
|
Package fault classifies recoverable PDF conformance faults. |
|
pdfcpu/font
Package font creates and manages PDF font dictionaries and resources.
|
Package font creates and manages PDF font dictionaries and resources. |
|
pdfcpu/form
Package form reads, writes, fills, and manages PDF form fields.
|
Package form reads, writes, fills, and manages PDF form fields. |
|
pdfcpu/format
Package format provides locale-independent PDF number formatting.
|
Package format provides locale-independent PDF number formatting. |
|
pdfcpu/matrix
Package matrix provides affine transformations for PDF coordinates.
|
Package matrix provides affine transformations for PDF coordinates. |
|
pdfcpu/model
Package model defines shared PDF processing state and configuration types.
|
Package model defines shared PDF processing state and configuration types. |
|
pdfcpu/pkcs7
Package pkcs7 implements parsing and generation of some PKCS#7 structures.
|
Package pkcs7 implements parsing and generation of some PKCS#7 structures. |
|
pdfcpu/primitives
Package primitives renders declarative page content and interactive form elements.
|
Package primitives renders declarative page content and interactive form elements. |
|
pdfcpu/safemath
Package safemath provides checked integer arithmetic for untrusted PDF data.
|
Package safemath provides checked integer arithmetic for untrusted PDF data. |
|
pdfcpu/sanitize
Package sanitize validates and normalizes filesystem paths derived from PDF data.
|
Package sanitize validates and normalizes filesystem paths derived from PDF data. |
|
pdfcpu/scan
Package scan tokenizes PDF object syntax.
|
Package scan tokenizes PDF object syntax. |
|
pdfcpu/sign
Package sign validates PDF signatures and their certificate evidence.
|
Package sign validates PDF signatures and their certificate evidence. |
|
pdfcpu/types
Package types defines low-level PDF objects, geometry, streams, and layout values.
|
Package types defines low-level PDF objects, geometry, streams, and layout values. |
|
pdfcpu/validate
Package validate implements validation against PDF 32000-1:2008.
|
Package validate implements validation against PDF 32000-1:2008. |