OfficeIMO CLI Documentation
Edit on GitHubTask guides for the officeimo CLI: install it, convert and batch documents, extract content, work with PDFs and invoices, script it in CI and run MCP.
officeimo is the command-line tool from the OfficeIMO.Tool NuGet package. It runs the same OfficeIMO engines as the .NET libraries, without Microsoft Office, from a shell script, a CI job, a scheduled task or an MCP client. These guides are organised by task. Each command also prints its own contract with officeimo <area> --help.
dotnet tool install --global OfficeIMO.Tool
officeimo convert report.docx
officeimo read report.docx --format markdown
officeimo hidden-data remove proposal.docx
Guides
| Guide | Covers |
|---|---|
| Install and pin the tool | Global install, a repository tool manifest, updates and version checks |
| Convert documents | One file at a time: Office, OpenDocument, Apple, email, HTML, text, spreadsheet and structured-data routes |
| Batch conversion and saved jobs | Folders, checkpoints, reusable job files, run reports and structured-data conversion |
| Extract and inspect | Markdown and JSON extraction, compact inspection, workbook schemas and the JSON contracts |
| PDF workflows | Page copies, splits, decryption, OCR, page images, assembly, comparison, printing and redaction |
| Before sharing | Hidden data, Content Credentials and AI labels, and provenance checks in CI |
| Invoices | Inspect, validate, edit, convert and render CII and UBL invoices |
| HTML to PDF and images | Render HTML, MHTML and ZIP site bundles with explicit resources, fonts and limits |
| OfficeIMO Markup | Validate markup, generate C# or PowerShell, and export Word, Excel and PowerPoint files |
| Scripting and CI | Exit codes, --force, standard output versus files, path rules, secrets, limits and GitHub Actions and Azure DevOps recipes |
| MCP and agents | The STDIO MCP server, allowed roots and the compact agent commands |
Command areas
| Area | What it does |
|---|---|
convert | Converts one file; the input and output extensions select the route |
read, extract, reader | Extract documents or folders as Markdown or JSON |
inspect, agent | Return compact, bounded JSON for inspection, search and fetch |
tabular | List worksheets, report column schemas and convert CSV, TSV and workbooks |
workflow | Batch conversion, saved jobs, page images, assembly, comparison, print plans and printing |
pdf | Separate PDF copies, splits, OCR, PDF/A conversion and source-bound redaction |
html | Render HTML, MHTML and ZIP site bundles to PDF or page images |
hidden-data, provenance | Clean documents before sharing and check them in CI |
invoice | Electronic invoice workflows |
markup | Parse, validate and preview OfficeIMO Markup, emit C# or PowerShell, and export Office files |
mcp | Start the MCP server over standard input and output |
officeimo help --format json lists every area, subcommand, option and exit code of the installed version as JSON; see Discover commands from the tool.
Safe by default
- No silent overwrites. Commands refuse to replace an existing output unless you pass
--force; batches use--conflict. Inputs are never modified. The exceptions are listed under overwrite rules. - Bounded work. Input size, output size, page counts and file counts have limits, so an unexpected file fails fast. Raise them per command only for trusted input; see resource limits.
- Bounded output. Results are one JSON object or NDJSON stream on standard output, with diagnostics on standard error. The
agentandinspectcommands cap their JSON with--max-output-characters. - No secrets on the command line. Passwords are read from environment variables you name.
- Exit codes you can branch on.
0success,1validation found errors,2usage,3input not found,4unsupported input,5operation failed,6output failed,130cancelled. See exit codes.
The command line covers the workflows listed here. The .NET libraries and PSWriteOffice expose more of each engine; Studio features are not automatically CLI commands.