-
Notifications
You must be signed in to change notification settings - Fork 541
command dump
zmworm edited this page May 4, 2026
·
6 revisions
Serialize a document into a replayable batch script — the round-trip mechanism for editing a document by emit → modify → replay.
officecli dump <file> [--format batch] [-o <path>] [--json]Walks the document and emits a JSON BatchItem[] array that, when replayed via officecli batch, reconstructs the source document. Currently .docx only.
The dump is portable: unstable IDs (paraId / rsidR / textId) and derived effective.* readbacks are filtered out. The OpenXML SDK regenerates IDs on save, so emit just stays out of the way.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
file |
path | Yes | - | Document path (.docx only in current release) |
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
--format |
string | No | batch |
Output format. Currently only batch is supported. |
-o / --out
|
path | No | - | Write output to file instead of stdout. Stdout output is the path on success. |
--json |
bool | No | false |
Standard JSON envelope wrapper (the batch payload itself is always JSON). |
| Layer | Mechanism |
|---|---|
/styles |
Emitted before body so paragraph styleId refs resolve on replay |
/body paragraphs |
Single-run paragraphs collapse into one add p row; multi-run paragraphs split into paragraph + run child rows |
| Tables and mixed body content | Typed add rows |
| Section page layout |
set / on the root for page width/height/margins/columns/etc. |
| Inline section breaks | Section breaks inside the body emitted alongside their paragraph |
docDefaults and document protection |
Emitted alongside section layout |
| Headers and footers | Seed paragraph + appended content per-part |
| Comments / footnote refs / endnote refs | Anchored to the body paragraphs they reference |
| Numbering | Emitted wholesale via raw-set when document has list templates |
| Settings part | Emitted wholesale via raw-set
|
| Theme part | Emitted wholesale via raw-set
|
| Charts | Typed add (chartType + data string) — not raw-set |
| Pictures | Inlined as data URIs through the src= prop |
Format keys are forwarded as-is; the OOXML schema reflection fallback in the Add side accepts arbitrary props, so emit doesn't need a per-key allowlist.
# Emit to stdout
officecli dump report.docx
# Write to a batch file
officecli dump report.docx -o report.batch.json
# Round-trip: dump → batch
officecli dump report.docx -o /tmp/r.json
officecli create rebuilt.docx --type docx
officecli batch rebuilt.docx --input /tmp/r.json- batch — replay the emitted JSON
- Word reference
Based on OfficeCLI v1.0.72