Skip to main content
Create, read and edit .xlsx workbooks, .docx documents and .pptx decks on any mount. Mirage implements the commands below with OfficeCLI’s paths, output and messages.

Setup

office has no account config. It reads and writes files through existing mounts.
For YAML registration, see the CLI overview.

SKILL.md

The SKILL.md an agent reads with office installed.
Available commandsThese commands are registered with this shell; --help after a command or subcommand shows its usage.office

Supported commands

Run office <command> --help for the supported flags and operands. This list is generated from Mirage’s registered command tree.

Usage

Edit a workbook

A path names the workbook (/), a sheet (/Sheet1), a cell (/Sheet1/A1 or Sheet1!A1), a range (/Sheet1/A1:C9), a row (/Sheet1/row[2]) or a comment by its place on the sheet (/Sheet1/comment[1]). get shows each cell’s value, type, font, fill, border, alignment, protection and number format, and the workbook’s and each sheet’s own properties. Renaming a sheet renames it in every formula, defined name, link and chart that points at it.

Batch

The items run against one open workbook, saved once. A failure anywhere leaves the workbook as it was, unless --best-effort keeps what succeeded; --stop-on-error stops at the first failure. The JSON also comes from --input FILE or stdin.

Query

A selector names cells (cell or a column letter such as B), rows, comments or sheets, scoped to one sheet with Sheet1! or /Sheet1/. Predicates in brackets compare a property with =, !=, ~=, >, <, >= or <= and join with and, or and not(...); :contains(text), :empty and :has(formula) filter cells, [N] picks a row or comment, , joins selectors and > picks children. A row predicate on a column name reads the sheet’s table, defined or found from its header row.

Read a document or deck

A Word path names the body (/body), a paragraph (/body/p[2] or /body/p[@paraId=1A2B3C4D]), its runs, a table, row or cell (/body/tbl[1]/tr[1]/tc[2]), a section (/section[1]), a style (/styles/Heading1), a header or a footer (/header[1]). A PowerPoint path names a slide (/slide[1]), a shape (/slide[1]/shape[@id=2]), its paragraphs and runs, a table, picture, chart, group, connector or placeholder (/slide[1]/placeholder[title]), a layout or a master. get shows each node’s own properties and what it inherits, as effective.* keys with the layer each came from in .src. A query selector names an element such as paragraph, run, table, cell, picture, style, slide or shape, with the same predicates, :contains(text) and :empty.

Edit a document

add makes a paragraph, a run or a hyperlink in a paragraph, a table, a row, a cell, a picture or a page, column or line break (pagebreak, columnbreak, break). A paragraph takes text (each \n starts another paragraph), style, alignment, spacing and indents, and the run props bold, italic, underline, size, font, color, highlight and the other toggles. A table takes rows and cols, or data with ; between rows and , between cells; a row takes its cells’ text as c1, c2 and so on, and height and header; a cell takes text, width, shading and gridSpan. set changes the same props on a paragraph or run, and text and shading on a cell. A built-in style such as Heading1 that the document lacks is added with Word’s definition. listStyle (bullet, numbered or none) with listLevel and start puts a paragraph in a list, continuing the list just before it when that one is the same kind. A hyperlink takes url or anchor, text and the run props. A picture takes src, a file or a base64 data: URI, with width and height; a side left out follows the image’s aspect, 6 inches wide by default. It also takes alt, name and crop, and wrap (square, tight, through or topandbottom) with hposition, vposition, hrelative and vrelative to float it. In a paragraph it is appended as a run; anywhere else it gets a paragraph of its own.

Edit a deck

add makes a slide from a layout, chosen by name, type or number, with its title and text; a text box with text, x, y, width, height, fill and the run props size, bold, italic, underline, color and font; a table of rows and cols, or data, and rows in it; a picture from src with x, y, width, height, alt, name, crop, rotation, flipH, flipV and opacity, centered and 6 inches wide at the image’s aspect unless placed; or a slide’s speaker notes with text. set changes the same props on a shape, text, the run props, fill and alignment on a table cell (/slide[N]/table[K]/tr[R]/tc[C]), text on /slide[N]/notes, and hidden and notes on a slide. A shape placed or moved prints its position, and a warning when another shape starts at the same spot. move and swap reorder slides, or the shapes of one slide.

Behavior

Differences from OfficeCLI

  • add makes the element types above; others, such as charts, comments and headers, and add --from are not available yet. set takes the props above.
  • A picture’s src is a file or a data: URI; a URL is not fetched.
  • Renaming a sheet changes only whole references to it, so OtherData!A1 stays when Data is renamed. Removing the last visible sheet is refused, and a list item added with --index, --after or --before continues the list just before it.
  • An equation’s text is plain, not LaTeX, and a chart in a deck shows its frame and name but not its plot properties.
  • A Word query reads paragraphs, runs, tables, rows, cells, pictures, hyperlinks, bookmarks, equations, content controls, sections, headers, footers and styles. A PowerPoint query returns no comments, OLE objects, zooms, 3D models or animations.
  • A document part that is not well-formed XML reads as absent, where OfficeCLI refuses the file.
  • A formula is stored without a computed value, and Excel calculates it on open. A formula cell with no stored value shows #OCLI_NOTEVAL! and evaluated=false.
  • set takes the props above; overwriting the first cell of a shared formula is refused.
  • query reads cells, rows, comments and sheets; charts, tables, pivot tables and other elements return no matches.
  • batch runs get, query, set, add, remove, move and swap items.
  • A save does not stamp the OfficeCLI.LastModified custom property.
  • Usage errors and --help use Mirage’s wording. Messages that name the command say office.

License

See compatibility and licenses.