CLICommands
renderersLast updated on
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:
| Renderer | Used for | Heavy dependency |
|---|---|---|
@open-form/renderer-text | Text/Markdown/HTML layers | handlebars |
@open-form/renderer-pdf | PDF layers, inspect command | pdf-lib |
@open-form/renderer-docx | DOCX layers | docx-templates |
Subcommands
| Command | Description |
|---|---|
status | Show installation status of all renderers |
install | Install a renderer (or all) |
remove | Remove a renderer (or all) |
update | Reinstall all renderers to match current CLI version |
renderers status
Show installation status of all renderers.
ofm renderers status [options]Options
| Option | Description |
|---|---|
--json | Output 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
| Argument | Description |
|---|---|
name | Renderer to install: text, pdf, or docx (optional; installs all if omitted) |
Examples
Install all renderers:
ofm renderers installInstall only the PDF renderer:
ofm renderers install pdfrenderers remove
Remove a renderer, or all renderers if no name is given.
ofm renderers remove [name]Arguments
| Argument | Description |
|---|---|
name | Renderer 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 updateThis is useful after upgrading the CLI to ensure renderer versions stay in sync.