Document conversion CLI reference

By Jetformat

Jetformat is a command-line tool for converting, inspecting, and editing documents. This reference groups commands by resource so you can choose the operation for a DOCX, XLSX, PPTX, PDF, HTML page, or supporting asset.

Run a document conversion step by step

1. Install the CLI and run jetformat validate source.docx on a supported input.
2. Inspect the source with a free read such as word inspect or text.
3. Sign in with jetformat login before a metered write, then run jetformat word to-pdf source.docx -o result.pdf.
4. Check the exit status and run jetformat pdf info result.pdf to inspect the file actually written.
5. Review page images when the task requires visual verification. Report the output path and observed page count.

Choose a resource

Pages

• Word to PDF and DOCX editing commands: Convert, inspect, and edit existing DOCX files. Reads are free; writes are one credit per command, to-pdf one per page.
• Excel to PDF and XLSX editing commands: Convert visible worksheets to PDF, read and write cells, and reshape workbooks. Reads are free; writes are one credit per command, to-pdf one per page.
• PowerPoint to PDF and PPTX editing commands: Convert decks to PDF and rearrange slides. Reads are free; writes are one credit per command, to-pdf one per page.
• PDF conversion, editing, and inspection commands: Read, combine, edit, secure, and render PDFs. Reading is free; writing a new PDF costs one credit per output page.
• HTML to PDF CLI reference (beta): One verb, to-pdf. Needs a separate renderer service. 1 credit per output page.
• Extract document text and validate files: Read what is already there and check a file before a job. Both are reads, so both are free and need no account.
• Inspect fonts, EMF images, and XMP metadata: Utility commands for fonts, EMF images, and XMP metadata. All free.
• CLI login, account status, and credit usage: One sign-in per machine for paid commands. Free commands never need it.
• Model guide: paste-ready instructions for another model.

Conventions

• Page numbers start at 1. last and all are accepted where a range is.
• Outputs are never overwritten unless you pass --force.
• Exit code 0 is success. Anything else prints the error and charges nothing.
• Free reads include text, validate, inspect, get, and pdf info. Conversion, PDF writes and rendering, and Office editing use credits. See the complete billing-unit table.

Understand billing units before a batch

A conversion producing 12 PDF pages uses 12 credits. Rendering 3 preview pages adds 3 credits. An Office edit uses 1 credit per command, so one template fill followed by that conversion and preview uses 16 credits. These are illustrative operation counts, not measured timings or a prediction of your file size.

Output pagination determines conversion usage. Three worksheets do not necessarily become three pages. Inspect a representative output before estimating a batch, and distinguish page-based writes from command-based Office edits.

Keep reads, edits, and previews separate

Text extraction reads existing content; validation checks structure; rendering creates an image. None alone proves all the others succeeded. A scanned PDF can pass validation while having no usable text layer, and a structurally valid workbook can still need formula recalculation.

Use a new output filename during an unfamiliar workflow. In-place examples with --force deliberately overwrite the target. Preserve the source until the derivative has passed the checks required by the task.

Know the supported boundaries

Office commands work with DOCX, XLSX, and PPTX. Legacy and macro-enabled variants are outside the supported input set. HTML rendering is beta and requires a separate service; ordinary Office and PDF processing use the local CLI. PDF-to-Word uses an existing text layer and does not perform OCR.

The underlying Office formats are described in ECMA-376. Use the resource pages above for Jetformat-specific limits, and Help Center for task-oriented workflows.