Usage

Explore the available commands and their usage.

Use:

pdfcpu [command] --help

for detailed information about a specific command.

Commands are grouped by functionality:

Core Commands

The basic processing features:

pdfcpu collect  inFile [ outFile ] [flags]
pdfcpu crop     description inFile [ outFile ] [flags]
pdfcpu merge    outFile inFile... [flags]
pdfcpu optimize inFile [ outFile ] [flags]
pdfcpu resize   description inFile [ outFile ] [flags]
pdfcpu rotate   inFile rotation [outFile] [flags]
pdfcpu split    inFile outDir [ span | pageNr... ] [flags]
pdfcpu trim     inFile [outFile] [flags]
pdfcpu validate inFile... [flags]
pdfcpu zoom     description inFile [outFile] [flags]

Stamps

Manage your stamps:

pdfcpu stamp add string | file description inFile [ outFile ] [flags]
pdfcpu stamp update string | file description inFile [ outFile ] [flags]
pdfcpu stamp remove inFile [ outFile ] [flags]

Watermarks

Manage your watermarks:

pdfcpu watermark add string | file description inFile [ outFile ] [flags]
pdfcpu watermark update string | file description inFile [ outFile ] [flags]
pdfcpu watermark remove inFile [ outFile ] [flags]

Forms

Manage your PDF forms:

pdfcpu form list   inFile... [flags]
pdfcpu form remove inFile [ outFile ] < fieldID | fieldName >... [flags]
pdfcpu form lock   inFile [ outFile ] [ fieldID | fieldName ]... [flags]
pdfcpu form unlock inFile [ outFile ] [ fieldID | fieldName ]... [flags]
pdfcpu form reset  inFile [ outFile ] [ fieldID | fieldName ]... [flags]
pdfcpu form export inFile [ outFileJSON ] [flags]
pdfcpu form fill   inFile inFileJSON [ outFile ] [flags]

Fonts

Manage core fonts and your user fonts:

pdfcpu fonts list [flags]
pdfcpu fonts install fontFiles... [flags]
pdfcpu fonts cheatsheet fontFiles... [flags]

Generate Commands

pdfcpu booklet [ description ] outFile n inFile | imageFiles... [flags]
pdfcpu create  inFileJSON [ inFile ] outFile [flags]
pdfcpu cut     description inFile outDir [ outFile ] [flags]
pdfcpu grid    [ description ] outFile m n inFile | imageFiles... [flags]
pdfcpu import  [ description ] outFile imageFile... [flags]
pdfcpu ndown   [ description ] n inFile outDir [ outFile ] [flags]
pdfcpu nup     [ description ] outFile n inFile | imageFiles... [flags]
pdfcpu poster  description inFile outDir [ outFile] [flags]

Pages

Insert or remove pages:

pdfcpu pages insert [ description ] inFile [ outFile ] [flags]
pdfcpu pages remove inFile [ outFile ] [flags]

Extract

Extract components and resources like fonts and images:

pdfcpu extract inFile outDir [flags]

Attachments

Manage your attachments:

pdfcpu attachments list inFile [flags]
pdfcpu attachments add inFile file... [flags]
pdfcpu attachments remove inFile [ file... ] [flags]
pdfcpu attachments extract inFile outDir [ file... ] [flags]

Portfolio

Manage your portfolios:

pdfcpu portfolio list inFile [flags]
pdfcpu portfolio add inFile file... [flags]
pdfcpu portfolio remove inFile [ file... ] [flags]
pdfcpu portfolio extract inFile outDir [ file... ] [flags]

Annotations

Manage your annotations:

pdfcpu annotations list inFile [flags]
pdfcpu annotations remove inFile [ outFile ] [ objNr | annotId | annotType]... [flags]

Images

Manage your images:

pdfcpu images list inFile... [flags]
pdfcpu images extract inFile outDir [flags]
pdfcpu images update inFile imageFile [ outFile ] [ objNr | (pageNr Id) ] [flags]

Encryption

Secure your PDFs:

pdfcpu encrypt     inFile [ outFile ] [flags]
pdfcpu decrypt     inFile [ outFile ] [flags]
pdfcpu changeopw   inFile opwOld opwNew [flags]
pdfcpu changeupw   inFile upwOld upwNew [flags]
pdfcpu permissions list inFile... [flags]
pdfcpu permissions set inFile [flags]

Print Supported Papersizes

pdfcpu paper [flags]

Keywords

Manage your keywords for searching:

pdfcpu keywords list inFile [flags]
pdfcpu keywords add inFile keyword... [flags]
pdfcpu keywords remove inFile [ keyword... ] [flags]

Properties

Manage your document properties:

pdfcpu properties list inFile [flags]
pdfcpu properties add inFile nameValuePair... [flags]
pdfcpu properties remove inFile [ name... ] [flags]

Page Layout

Manage the page layout for your opened document:

pdfcpu pagelayout list inFile [flags]
pdfcpu pagelayout set inFile value [flags]
pdfcpu pagelayout reset inFile [flags]

Page Mode

Manage the page mode for your opened document:

pdfcpu pagemode list inFile [flags]
pdfcpu pagemode set inFile value [flags]
pdfcpu pagemode reset inFile [flags]

Signatures

Manage digital signatures:

pdfcpu signatures remove inFile [ outFile ] [flags]
pdfcpu signatures validate inFile [flags]

Viewer Preferences

Manage the viewer preferences for your opened document:

pdfcpu viewerpref list inFile [flags]
pdfcpu viewerpref set inFile ( inFileJSON | JSONstring ) [flags]
pdfcpu viewerpref reset inFile [flags]

Bookmarks

Manage your bookmarks:

pdfcpu bookmarks list inFile [flags]
pdfcpu bookmarks import inFile inFileJSON [ outFile ] [flags]
pdfcpu bookmarks export inFile [ outFileJSON ] [flags]
pdfcpu bookmarks remove inFile [ outFile ] [flags]

Boxes

Manage your page boundaries:

pdfcpu boxes list [ boxTypes ] inFile [flags]
pdfcpu boxes add description inFile [ outFile ] [flags]
pdfcpu boxes remove boxTypes inFile [ outFile ] [flags]

Config

Manage your configuration:

pdfcpu config list [flags]
pdfcpu config reset [flags]

Info

Print file details:

pdfcpu info inFile... [flags]

Print definition of the -pages flag

pdfcpu selectedpages [flags]

Print Version

pdfcpu version [flags]