Package Exports
- pdfix-cli
- pdfix-cli/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (pdfix-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
PDFix SDK CLI App
PDFix SDK CLI App packaged for npm.
PDFix SDK is a cross-platform PDF processing toolkit for automating PDF accessibility, document remediation, data extraction, and PDF conversion workflows. The PDFix CLI App exposes those SDK capabilities as a command-line tool that can be used from shells, build pipelines, batch jobs, server-side automation, and Node.js applications.
This npm package resolves the correct native PDFix CLI runtime for the current platform and provides JavaScript helpers plus npm bin shims for invoking the CLI from a Node.js project.
What PDFix CLI App is for
Use PDFix CLI App when you need scriptable PDF automation without integrating directly with the PDFix SDK API. Common use cases include:
- Automated PDF accessibility remediation for PDF/UA and WCAG-oriented workflows
- Adding and improving tags, document structure, reading order, annotations, metadata, and fonts
- Extracting PDF content, forms, bookmarks, tags, page objects, highlighted text, tables, images, and document data to formats such as JSON, XML, CSV, text, and images
- Converting PDFs to HTML or structured data for web, archive, review, and downstream processing workflows
- Rendering PDF pages to raster images for previews, validation, or quality assurance
- Applying common document operations such as watermarking, flattening, redaction, page insertion, page deletion, page movement, digital signatures, form import/export, and security removal
- Running batch processing and JSON-configured PDF Actions in automated production pipelines
Package behavior
pdfix-cli is the public resolver package. It installs optional
platform-specific runtime packages and selects the compatible native binary at
runtime.
The package exposes:
getPdfixCliPath()to locate the native PDFix CLI executablerunPdfixCli(args, options)to launch the CLI from Node.jspdfix-cli,pdfix, andpdfix_appbin shims that forward arguments to the native PDFix CLI App
Usage examples
Install pdfix-cli in the project that needs to run PDFix CLI automation.
The package installs the matching platform runtime through optional
dependencies.
npm install pdfix-cliAfter installation, use any of the provided bin names to inspect the live CLI help from the packaged runtime.
npx pdfix -h
npx pdfix --version
npx pdfix make-accessible -hThe npm bins forward arguments to the native PDFix CLI App. For example, a project script can call PDFix commands through the package-managed binary:
{
"scripts": {
"pdfix:help": "pdfix -h",
"pdfix:version": "pdfix --version"
}
}For Node.js integrations, resolve the native executable path when another tool needs the binary location:
const { getPdfixCliPath, isPdfixCliAvailable } = require('pdfix-cli');
if (!isPdfixCliAvailable()) {
throw new Error('PDFix CLI App runtime is not available for this platform.');
}
console.log(getPdfixCliPath());Or spawn the CLI directly from application code:
const { runPdfixCli } = require('pdfix-cli');
const child = runPdfixCli(['--version']);
child.on('exit', (code) => {
process.exitCode = code === null ? 1 : code;
});For the current command list and option details, call the installed CLI with
-h, --help, or the command-specific help output. The CLI help is generated
from the packaged runtime, so it is the best source for exact syntax.
Keywords
PDFix, PDFix SDK, PDFix CLI, PDF SDK, PDF command line, PDF automation, PDF accessibility, PDF remediation, PDF/UA, WCAG, Section 508, accessible PDF, automated tagging, PDF tags, PDF structure tree, PDF data extraction, PDF to JSON, PDF to XML, PDF to CSV, PDF to text, PDF to image, PDF to HTML, PDF forms, AcroForm, PDF rendering, PDF watermark, PDF redaction, PDF digital signature, PDF metadata, PDF batch processing.
Resources
- PDFix SDK: https://pdfix.net/products/pdfix-sdk/getting-started/
- PDFix SDK CLI documentation: https://raw.githubusercontent.com/pdfix/pdfix_sdk_builds/refs/heads/main/command_line.md