iOfficeAI/OfficeCLI

Maintainer? Show your league in your README

Card: your league's emblem, from Copper to Legendary

[![bestofgithub](https://bestofgithub.dev/badge/iOfficeAI/OfficeCLI.svg?style=card)](https://bestofgithub.dev/repo/iOfficeAI/OfficeCLI)

Flat: fits beside your other badges

[![bestofgithub](https://bestofgithub.dev/badge/iOfficeAI/OfficeCLI.svg)](https://bestofgithub.dev/repo/iOfficeAI/OfficeCLI)

Loading README…

Format	Read	Modify	Create
Word (.docx)	✅	✅	✅
Excel (.xlsx)	✅	✅	✅
PowerPoint (.pptx)	✅	✅	✅

Platform	Binary
macOS Apple Silicon	`officecli-mac-arm64`
macOS Intel	`officecli-mac-x64`
Linux x64	`officecli-linux-x64`
Linux ARM64	`officecli-linux-arm64`
Windows x64	`officecli-win-x64.exe`
Windows ARM64	`officecli-win-arm64.exe`

Layer	Purpose	Commands
L1: Read	Semantic views of content	`view` (text, annotated, outline, stats, issues, html, svg, screenshot)
L2: DOM	Structured element operations	`get`, `query`, `set`, `add`, `remove`, `move`, `swap`
L3: Raw XML	Direct XPath access — universal fallback	`raw`, `raw-set`, `add-part`, `validate`

	OfficeCLI	Microsoft Office	LibreOffice	python-docx / openpyxl
Open source & free	✓ (Apache 2.0)	✗ (paid license)	✓	✓
AI-native CLI + JSON	✓	✗	✗	✗
Zero install (single binary)	✓	✗	✗	✗ (Python + pip)
Call from any language	✓ (CLI)	✗ (COM/Add-in)	✗ (UNO API)	Python only
Path-based element access	✓	✗	✗	✗
Raw XML fallback	✓	✗	✗	Partial
Built-in agent-friendly rendering engine	✓	✗	✗	✗
Headless HTML/PNG output	✓	✗	Partial	✗
Template merge (`{{key}}`) across formats	✓	✗	✗	✗
Round-trip dump → batch JSON	✓	✗	✗	✗
Live preview (auto-refresh on edit)	✓	✗	✗	✗
Headless / CI	✓	✗	Partial	✓
Cross-platform	✓	Windows/Mac	✓	✓
Word + Excel + PowerPoint	✓	✓	✓	Separate libs

Command	Description
`create`	Create a blank .docx, .xlsx, or .pptx (type from extension)
`view`	View content (modes: `outline`, `text`, `annotated`, `stats` (`--page-count`), `issues`, `html`, `svg`, `screenshot`, `pdf` (via exporter plugin), `forms` (via format-handler plugin)). docx supports `--render auto\|native\|html`.
`load_skill`	Print embedded SKILL.md content for a specialized skill (no install)
`get`	Get element and children (`--depth N`, `--json`)
`query`	CSS-like query with boolean `and`/`or`, row-by-column-name (`row[Salary>5000]`), `--find` flag
`set`	Modify element properties; accepts selectors and Excel-native paths (parity with `get`/`query`), `--find`/`--replace` flags
`add`	Add element (or clone with `--from <path>`)
`remove`	Remove an element
`move`	Move element (`--to <parent>`, `--index N`, `--after <path>`, `--before <path>`)
`swap`	Swap two elements
`validate`	Validate against OpenXML schema
`view <file> issues`	Enumerate document issues (text overflow, missing alt text, formula errors, ...)
`batch`	Multiple operations applied in a single pass (stdin, `--input`, or `--commands`; atomic by default — any failed item rolls back the whole batch — `--best-effort` to keep partial progress, `--stop-on-error` to abort early)
`dump`	Serialize a `.docx`, `.pptx`, or `.xlsx` into a replayable batch JSON (round-trip via `batch`); accepts a subtree path
`refresh`	Recalculate TOC page numbers / `PAGE` / cross-references (`.docx`; Word backend on Windows, headless-HTML fallback)
`plugins`	List / inspect / lint installed plugins (extend to `.doc`, `.hwpx`, `.pdf` export via dump-reader / exporter / format-handler kinds)
`merge`	Template merge — replace `{{key}}` placeholders with JSON data
`watch`	Live HTML preview in browser with auto-refresh
`mcp`	Start MCP server for AI tool integration
`raw`	View raw XML of a document part
`raw-set`	Modify raw XML via XPath
`add-part`	Add a new document part (header, chart, etc.)
`open`	Start resident mode (keep document in memory)
`close`	Save and close resident mode
`install`	Install binary + skills + MCP (`all`, `claude`, `cursor`, etc.)
`config`	Get or set configuration
`help <format> <command>`	Built-in help (e.g. `officecli help pptx set shape`)

iOfficeAI/OfficeCLI

OfficeCLI

For AI Agents — Get Started in One Line

For Humans

For Developers — See It Live in 30 Seconds

Quick Start

Why OfficeCLI?

Use Cases

Installation

Key Features

Built-in Engines & Generation Primitives

Rendering engine — high-fidelity, built-in

Formula & pivot engine

Template merge — generate once, fill many

Round-trip dump — learn from existing docs

Resident Mode & Batch

Three-Layer Architecture

AI Integration

MCP Server

Direct CLI Integration

Why your agent will thrive on OfficeCLI

Built-in Help

JSON Output Schemas

Comparison

Command Reference

End-to-End Workflow Example

Units & Colors

Common Patterns

Documentation

Build from Source

License

Type	Accepted formats	Examples
Dimensions	cm, in, pt, px, or raw EMU	`2cm`, `1in`, `72pt`, `96px`, `914400`
Colors	Hex, named, RGB, theme	`#FF0000`, `FF0000`, `red`, `rgb(255,0,0)`, `accent1`
Font sizes	Bare number or pt-suffixed	`14`, `14pt`, `10.5pt`
Spacing	pt, cm, in, or multiplier	`12pt`, `0.5cm`, `1.5x`, `150%`