PyPDFForm CLI
PyPDFForm CLI saves a filled form as a separate PDF, with fields left editable or marked read-only for later viewing.
- 1,238 ★ on the repository
- Last commit
- MIT
Extended access
Why this level
- The CLI reads and writes PDFs and form data that may contain personal information.
Install
In your terminal, with SkillFoxx CLI
npx skillfoxx add cli/pypdfform-cliDetects the agents on your machine, shows the access level and pins the version.
Other ways to install
Access and checks
How we reviewExtended accessThe tool runs code or makes network calls and only reads external data.
- The CLI reads and writes PDFs and form data that may contain personal information.
This is third-party code. Review the repository files before installing.
What it does
PyPDFForm CLI inspects PDF form names, types and values, fills them with supplied data and writes a selected output PDF. It also creates or updates fields, styles them and performs page operations. A generated JSON Schema helps validate input. Agents can prepare values from that schema, while users review the completed document before delivery.
Who it is for. Document workflow operators repeatedly filling PDF forms from structured data.
Good fit when
- An operator fills a PDF template from prepared JSON or YAML values.
- Before automation, you obtain the template’s actual field names and types.
- A user inspects current values in an already filled form.
- Several documents use one schema with separate input values and output files.
Not a fit when
- The source is a scan without fields and needs automatic form recognition.
- You require a verified digital signature rather than filling an image/signature field.
- The output would be sent without inspecting values and layout.
Example request
Inspect this PDF form schema, prepare test values in YAML and fill a copy for review before sharing.Limitations
The CLI needs the `cli` extra; the base Python library alone is insufficient. Input data must use actual field names and suitable value types from the form schema. Radio choices use zero-based indexing: 0 selects the first item in a group. Filled fields remain editable by default. `--readonly` marks the filled fields as read-only; verify the resulting behavior in the PDF viewer used for the document.
How to disable. Uninstall the CLI from pipx. Templates, input data and completed PDFs have separate retention requirements.
FAQ
How do I install the CLI specifically?
Use `pipx install "PyPDFForm[cli]"`; the earlier pip block installs the library.
How do I inspect fields?
Run `pypdfform inspect schema sample_template.pdf` with your template path. It returns field names and types as a schema for preparing input data.
How do I supply YAML values?
The `fill` command uses `-f` for data and `-o` for a new output PDF. Supplying dropdown text absent from the existing options adds and selects a new option.
Can I read current values?
Yes. `pypdfform inspect data` reads filled fields. Keep personal information private.
How do I make filled fields read-only?
Add `--readonly` when filling to mark completed fields as read-only. Open the result in the intended PDF viewer before sharing it.
Discussion
No questions or reviews yet.
Related
CLI toolspdfcpu validates, merges and splits PDFs, extracts content and manages pages through a dedicated command-line interface.
Translates scientific PDFs while keeping formulas, tables and layout intact, as a CLI, Docker image and MCP server for agents
MCP PDF from ComPDF: the agent converts PDFs and images to Word, Excel, Markdown and JSON and merges, splits, protects and compares files via a cloud API
A skill that typesets resumes, one-pagers, letters, reports and slides from templates into PDF, PNG and PPTX and checks the result before delivery
An MCP server on top of pandoc: the agent converts Markdown, HTML, DOCX, LaTeX, EPUB, ODT and other formats into one another
Nutrient's official skill for PDF work via the DWS Processor API: conversion, OCR, extraction, redaction, signing and PDF/A
README in short
Beyond form fields, separate commands extract pages and merge PDFs. These file operations are distinct from preparing form values.