Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/apache/pdfbox/llms.txt

Use this file to discover all available pages before exploring further.

PDFBox ships a standalone application JAR (pdfbox-app) that bundles every command-line utility into a single executable. You can download it from the Apache PDFBox releases page and run any built-in command without additional classpath setup. All commands require Java 11 or later on your PATH.

Download and run

Download the app JAR and invoke it with the subcommand of your choice:
java -jar pdfbox-app-3.0.0.jar <command> [options]
Pass help or --help to list available subcommands, or help <command> for per-command usage:
java -jar pdfbox-app-3.0.0.jar help
java -jar pdfbox-app-3.0.0.jar help export:text

Available commands

CommandSubcommand nameDescription
ExtractTextexport:textExtract plain text, HTML, or Markdown from a PDF
ExtractImagesexport:imagesSave all embedded images to individual files
PDFToImagerenderRender each PDF page to an image file (JPG, PNG, etc.)
PDFMergermergeCombine multiple PDFs into a single document
PDFSplitsplitDivide a PDF into separate files by page range
EncryptencryptApply password or certificate-based encryption
DecryptdecryptRemove encryption from a PDF using a password or cert
OverlayPDFoverlayOverlay one PDF on top of another
PrintPDFprintSend a PDF to a printer
TextToPDFfromtextConvert a plain-text file to a PDF
ImageToPDFfromimagePack one or more images into a PDF
ExportFDFexport:fdfExport form field data to FDF format
ImportFDFimport:fdfImport FDF form data into a PDF
ExportXFDFexport:xfdfExport form field data to XFDF (XML) format
ImportXFDFimport:xfdfImport XFDF form data into a PDF
ExtractXMPexport:xmpExtract XMP metadata from a PDF
DecompressObjectstreamsdecodeDecode and decompress object streams for debugging
Java 11 or later is required. The pdfbox-app JAR bundles Bouncy Castle for encryption support — no additional dependencies are needed on the classpath.

Individual tool pages

ExtractText

Extract text content from PDF documents

ExtractImages

Save embedded images from PDFs to disk

PDFToImage

Render PDF pages to image files

PDFMerger and PDFSplit

Combine or divide PDF documents

Encrypt and Decrypt

Manage PDF passwords and permissions

Build docs developers (and LLMs) love