OpenForm
CLICommands

renderers

Last updated on

Manage renderer plugins

Manages renderer plugins used by the render and inspect commands.

Usage

ofm renderers <command>

Overview

Renderers are not bundled with the CLI to keep the base install small (~1.1 MB). Instead, they are installed on demand the first time you run render or inspect. Installed renderers are cached in ~/.open-form/renderers/.

Available renderers:

RendererUsed forHeavy dependency
@open-form/renderer-textText/Markdown/HTML layershandlebars
@open-form/renderer-pdfPDF layers, inspect commandpdf-lib
@open-form/renderer-docxDOCX layersdocx-templates

Subcommands

CommandDescription
statusShow installation status of all renderers
installInstall a renderer (or all)
removeRemove a renderer (or all)
updateReinstall all renderers to match current CLI version

renderers status

Show installation status of all renderers.

ofm renderers status [options]

Options

OptionDescription
--jsonOutput as JSON

Output

Renderer plugins

Package                        Installed  Expected  Status  Size
@open-form/renderer-text       0.2.1      0.2.1     ok      245.3 KB
@open-form/renderer-pdf        0.2.1      0.2.1     ok      1.2 MB
@open-form/renderer-docx       not installed  0.2.1  -       -

renderers install

Install a renderer, or all renderers if no name is given.

ofm renderers install [name]

Arguments

ArgumentDescription
nameRenderer to install: text, pdf, or docx (optional; installs all if omitted)

Examples

Install all renderers:

ofm renderers install

Install only the PDF renderer:

ofm renderers install pdf

renderers remove

Remove a renderer, or all renderers if no name is given.

ofm renderers remove [name]

Arguments

ArgumentDescription
nameRenderer to remove: text, pdf, or docx (optional; removes all if omitted)

renderers update

Reinstall all renderers to match the versions pinned by the current CLI release.

ofm renderers update

This is useful after upgrading the CLI to ensure renderer versions stay in sync.

See also

  • render - Render artifact layers
  • inspect - Inspect PDF form fields
  • reset - Reset CLI (also clears renderers)

On this page