Skip to main content

Installation and operation of axesFlip CLI

System requirements

Please refer to System requirements.

Download

Download the axesFlip ZIP package. Extract the ZIP package and copy it to a suitable location: 
Download axesFlip

Configuration

Before using axesFlip CLI, you must create a configuration file (flip.config.json) with your own settings. For details and sample configuration files, please refer to axesFlip CLI configuration guide.

Starting axesFlip CLI

Open a command-line interface, navigate to the axesFlip CLI directory, and start it by typing:

axesflip

Demo mode

If no valid license key is configured, axesFlip operates in demo mode. You have access to all functions, but the resulting PDF files have watermarks and random color translations of individual characters. 

An exception applies if the environment is set to "Production"—in this case, axesFlip terminates with an error message instead of starting in demo mode.

Available Commands

Remediating a Single File

Processes a single PDF file and applies remediation rules defined in a template file. The resulting document is written to the specified output directory:

remediate-file <file-path> <output-directory-path> <template-file-path>

Remediating a directory of files

Processes all PDF files in a directory. Successfully processed files are written to the output path. Files that fail remediation are stored in the error path:

remediate-directory <input-path> <output-path> <error-path> <template-file-path>

To remediate PDF files in nested directories as well, add the --recursive option

remediate-directory <input-path> <output-path> <error-path> <template-file-path> --recursive