Office documents through the CLI

Launch and discover

moonx moonbitlang/office help all --json
moonx moonbitlang/office help schemas --json
moonx moonbitlang/office help schema xlsx.batch/2 --json

Choose an operation

Reading and selectors

/docx/body/p[1]
/docx/body/tbl[1]/tr[1]/tc[2]/p[1]
/docx/comments/comment[id="7"]
/xlsx/sheet[name="Data"]/cell[A1]
/xlsx/sheet[name="Data"]/range[A1:C12]

• Ordinary JSON commands return an office.output/1 envelope. Check success before reading data; failures may have only error.
• dump --json instead returns the replayable office.dump/1 document directly. dump --jsonl is a streaming inspection form, not replay input.
• XLSX get returns data.cell as an object for a cell selector and data.cells as an array for a range selector.
• DOCX query matches carry preview and preview_truncated, not a text field.
• Text/query scans are bounded. Inspect truncated, returned, and matched_total; paginate with --offset/--limit as needed. A failed or partial scan does not establish that content is absent.
• DOCX outline carries counts, headings, comments, and revisions; XLSX outline carries sheets and sheet_count. Do not assume identical shapes. Outline refuses when its resource limits are exceeded instead of returning a partial successful outline.

Mutation contracts

Editing existing DOCX text

• replace_text: params contains find, replace, and optional occurrence. Matching is literal, can cross runs, and uses the original snapshot for every op. Omitted occurrence means all matches; N selects the Nth. Overlapping matches refuse. Unmatched ops refuse unless --allow-unmatched is supplied; unsupported rewrite contexts also refuse rather than silently skipping text.
• accept_revision / reject_revision: select by id, author, type (ins/del), or all: true. Specified fields are conjunctive. Only resolve revisions when that is part of the requested task.
• set_run_text (docx.edit/2): params contains at, expect, and text. at addresses one run, for example /docx/body/p[3]/r[2] or p[id="1A2B3C4D"]/r[2]. expect must equal its entire current text; text replaces the entire run text. Use this when selecting a specific run is more precise than matching a repeated literal.

Authoring tables and comments

{"op": "table", "params": {"header_rows": 1, "rows": [
  [{"text": "Area"}, {"text": "Owner"}],
  [{"text": "Cache"}, {"text": "Dana"}]
]}}

{"schema": "docx.annotation-batch/1", "ops": [
  {"op": "comment_add", "anchor": {"at": "/docx/body/p[1]"},
   "author": "Reviewer", "body": ["Please confirm this amount."]}
]}

Reviewing DOCX comments and revisions

Verification matched to the task

• Package integrity: validate --json runs the shared mutation package gate. Require a successful response with data.error_count == 0; this is not a complete OOXML Schema or Microsoft OpenXML SDK validation.
• Diagnostics: inspect issues --json findings and their scope. Exit zero can still carry warnings. Determine whether each finding affects the task; an empty bounded report is not proof of complete correctness.
• Content: use text, get, or query to verify changed content. Complete the relevant pagination before asserting absence of unexpected placeholders or omissions. Template markers, code escapes, and TODO text can be intentional.
• Review state: preserve comments and tracked changes for review deliverables. Require resolution only when the requested output is a finalized clean copy; account for the revision types the CLI cannot inventory.
• Formulas: when formula results need verification, use the xlsx lint fallback below and inspect finding_count/findings. issues only inspects cached errors, and preview does not evaluate uncached formulas. Lint evaluates formula masters, not shared/array slaves; no findings does not prove every formula correct.
• Appearance: open the generated HTML preview in an available viewer, or render DOCX to PDF/SVG and inspect it. Check pages_total, images_dropped, and unsupported notices; notices are not exhaustive. Rendering is not a guarantee of Word-identical pagination or viewer-computed field results. Report whether the result was actually viewed, rather than equating generated HTML/PDF with visual verification.

Format-specific fallbacks