Jetformat

Install the Jetformat CLI

Install with Homebrew or npm, or download the ready-to-run archive, put the binary on PATH, then connect the agent adapter you use.

By Jetformat

Jetformat CLI installation makes the jetformat command available to your shell or agent. Installing the binary does not require an account. Start with a free read, then sign in before a metered conversion or document edit.

Choose an installation method

Method Use it when Check afterwards
Homebrew Homebrew is your package manager The binary resolves on PATH
npm Node.js 18 or newer is available The global binary directory is on PATH
Direct archive You need a platform-specific executable OS and architecture match the machine

Choose one method for the first installation:

brew install jetformat/tap/jetformat

Or use npm:

npm install -g jetformat

Direct archives and checksums are linked from Download. Extract the archive for your OS and architecture, then place the executable on PATH. A Go toolchain is not needed for the downloaded binary.

Verify the execution environment

jetformat --version
jetformat validate report.docx
jetformat word inspect report.docx --json

Replace report.docx with a real supported file. Text extraction, validation, and inspection are free reads and need no sign-in. If the shell reports that the command cannot be found, fix PATH before investigating the input file. An agent or CI runner can have a different PATH from your interactive terminal.

Run the first conversion in order

  1. Verify the binary version and confirm a free read can open the source.
  2. Run jetformat login on the machine that will perform the metered write.
  3. Choose a new output path and run the conversion below.
  4. Inspect the generated PDF and report its actual page count.
  5. Open the PDF or rendered previews when the task requires visual review.
jetformat login
jetformat word to-pdf report.docx -o report.pdf
jetformat pdf info report.pdf

An illustrative 12-page conversion uses 12 credits. Rendering 2 preview pages adds 2 credits, while validation and inspection add 0 credits. Every account receives 80 free credits a month; pricing explains plans and packs.

Connect an agent to the installed CLI

An adapter provides instructions or tools that invoke the binary; it does not replace the binary. Follow the dedicated guide for the Jetformat Skill, Claude plugin, or DeepSeek Harness plugin. For other hosts, use the model guide.

Test a real input path from the agent’s environment. Ask it to report the command outcome, output file, and observed page count. A proposed command is not evidence that a conversion ran.

Configure HTML separately

The beta html to-pdf command requires a separate renderer. Set JETFORMAT_HTML_SERVER or pass --server for the actual service address; an environment variable does not install or start that service. Office and ordinary PDF processing do not use it. See HTML setup.

Last updated