-
Notifications
You must be signed in to change notification settings - Fork 528
command plugins
zmworm edited this page May 24, 2026
·
1 revision
Manage and inspect installed OfficeCLI plugins. Plugins are sidecar processes that extend support to additional formats (.doc, .hwpx, .pdf export, etc.) without bloating the main binary or coupling external implementations to its license.
officecli plugins list [--json] officecli plugins info <name> [--json] officecli plugins lint <name> [--fixture <path>] [--json]
| Subcommand | Description |
|---|---|
list |
List plugins discoverable in the standard search paths |
info <name> |
Show the full manifest for a single plugin |
lint <name> |
Sanity-check a plugin (manifest schema, capability probe, optional round-trip against a fixture). |
| Kind | Purpose | Lifecycle | IPC |
|---|---|---|---|
dump-reader |
Read a foreign format (e.g. .doc) and emit OfficeCLI batch items for replay into a sibling native file (.docx/.xlsx/.pptx). Cache is keyed by mtime. |
Short-lived | None — JSONL on stdout |
exporter |
Render native content into a foreign target (e.g. .pdf). Source path is read-only. |
Short-lived | None — plain CLI |
format-handler |
Own a foreign format end-to-end (e.g. .hwpx, .hwp). Holds the file open for the whole session and serves all document operations. |
Long-lived | stdin/stdout JSONL frames + named-pipe RPC |
engine and transformer kinds are reserved for future use.
For (kind, ext), the first match wins:
-
$OFFICECLI_PLUGIN_<KIND>_<EXT>env var (absolute path) ~/.officecli/plugins/<kind>/<ext>/plugin[.exe]<officecli-dir>/plugins/<kind>/<ext>/plugin[.exe]- PATH lookup —
officecli-<kind>-<ext>orofficecli-<ext>
<kind> uses kebab-case (dump-reader, format-handler, exporter).
-
Unknown extension (e.g.
officecli view foo.doc text) — main routes through the plugin registry; if adump-readeris installed it migrates to a sibling native file before opening. -
view <file> pdf [--out <path>]— runs through anexporterplugin (file lock is released first). -
All verbs on a
format-handlerextension —view html / view forms / create / get / set / add / remove / moveproxy through a long-lived plugin session over named-pipe RPC.
# List installed plugins officecli plugins list officecli plugins list --json # Inspect one officecli plugins info officecli-doc # Sanity-check (optionally with a sample file) officecli plugins lint officecli-doc --fixture tests/sample.doc
-
export —
view <file> pdfis the supported surface -
view —
pdf,forms,svgmodes can route through plugins
Based on OfficeCLI v1.0.97