iofficeai

Professional software vendor delivering innovative solutions on the Softono platform. Specialized in both open-source and proprietary software development.

Visit Website

Total Products

Software by iofficeai

Open Source

AionUi

<img src="./resources/aionui-banner-1.png" alt="AionUi - Cowork with AI Agents" width="100%"> <img src="https://img.shields.io/github/v/release/iOfficeAI/AionUi?style=flat-square&color=32CD32" alt="Version">   <img src="https://img.shields.io/badge/license-Apache--2.0-32CD32?style=flat-square&logo=apache&logoColor=white" alt="License">   <img src="https://img.shields.io/badge/platform-macOS%20%7C%20Windows%20%7C%20Linux-6C757D?style=flat-square&logo=linux&logoColor=white" alt="Platform"> <a href="https://trendshift.io/repositories/15423" target="_blank"> <img src="https://trendshift.io/api/badge/repositories/15423" alt="GitHub Trending" height="80"> </a> --- A free, open-source, Cowork app with AI Agents Built-in Agent | Zero Setup | Any API Key | Multi-Agents | Remote Access | Cross-Platform | 24/7 Automation <a href="https://github.com/iOfficeAI/AionUi/releases"> <img src="https://img.shields.io/badge/⬇️%20Download%20Now-Latest%20Release-32CD32?style=for-the-badge&logo=github&logoColor=white" alt="Download Latest Release" height="50"> </a> English | <a href="./docs/readme/readme_ch.md">简体中文</a> | <a href="./docs/readme/readme_tw.md">繁體中文</a> | <a href="./docs/readme/readme_jp.md">日本語</a> | <a href="./docs/readme/readme_ko.md">한국어</a> | <a href="./docs/readme/readme_es.md">Español</a> | <a href="./docs/readme/readme_pt.md">Português</a> | <a href="./docs/readme/readme_tr.md">Türkçe</a> | <a href="./docs/readme/readme_ru.md">Русский</a> | <a href="./docs/readme/readme_uk.md">Українська</a> | <a href="https://www.aionui.com" target="_blank">Official Website</a> 💬 Community: <a href="https://discord.gg/2QAwJn7Egx" target="_blank">Discord (English)</a> | <a href="./resources/wx-11.png" target="_blank">微信 (中文群)</a> | <a href="https://twitter.com/AionUI" target="_blank">Twitter</a> --- ## 📋 Quick Navigation [Cowork in Action](#-cowork-in-action) · [Why Choose AionUi?](#-why-choose-aionui-over-claude-cowork) · [Quick Start](#-quick-start) · [Community](#-community--support) --- ## Cowork — AI Agents That Work Alongside You **AionUi is more than a chat client.** It's a Cowork platform where AI agents work alongside you on your computer — reading files, writing code, browsing the web, and automating tasks. You see everything the agent does, and you're always in control. | | Traditional AI Chat Clients | **AionUi (Cowork)** | | :------------------------------ | :-------------------------- | :---------------------------------------------------------------------------------------------------------------------- | | AI can operate on your files | Limited or No | **Yes — built-in agent with full file access** | | AI can execute multi-step tasks | Limited | **Yes — autonomous with your approval** | | Remote access from phone | Rarely | **WebUI + Telegram / Lark / DingTalk / WeChat** | | Scheduled automation | No | **Cron — 24/7 unattended** | | Multiple AI Agents at once | No | **Claude Code, Codex, Qwen Code, Hermes Agent, Snow CLI, Cursor Agent and 13+ more — auto-detected, unified interface** | | Price | Free / Paid | **Free & Open Source** | <img src="./resources/offica-ai BANNER-function.png" alt="AionUi Cowork Platform" width="800"> --- ## Built-in Agent — Install & Go, Zero Configuration AionUi ships with a complete AI agent engine. Unlike tools that require you to install CLI agents separately, **AionUi works the moment you install it**. - **No CLI tools to install** — the agent engine is built in - **No complex setup** — paste any API key to get started - **Full agent capabilities** — file read/write, web search, image generation, MCP (Model Context Protocol) tools - **Ready-to-use assistants** — 21 built-in professional assistants (Cowork, PPT Creator, Word Creator, Word Form Creator, Excel Creator, Morph PPT, Morph PPT 3D, Pitch Deck Creator, Dashboard Creator, Academic Paper Writer, Financial Model Creator, and more) ready to use immediately <img src="./resources/homepage.png" alt="Built-in Agents" width="800"> ### **Office assistants — PPT, Word & Excel** These tracks match what the app actually ships: **Morph PPT** presets and the **`pptx` / `docx` / `xlsx` skills** (see `assistant/` presets and `skills/` in the repo). Want document/table output? AionUi’s built-in **[OfficeCLI](https://github.com/iOfficeAI/OfficeCli)** helps PPT (Morph), Word (`.docx`), and Excel (`.xlsx/.xlsm/.csv`) go from request to deliverable faster and more reliably. The three assistant types map to file workflows, and the final outputs are directly editable and reusable. #### **PPT assistant** > **Output:** editable Morph PPT (`.pptx`) > Morph-animated slide-to-slide transitions with coherent story pacing; powered by [OfficeCLI](https://github.com/iOfficeAI/OfficeCli). <table> <tr> <td align="center" width="50%"> <img src="./resources/morph-ppt-balanced.gif" alt="Morph PPT — slide-to-slide transitions (OfficeCLI)" width="390"> </td> <td align="center" width="50%"> <img src="./resources/readme-demo-assistant-ppt.gif" alt="PPT assistant — screen recording" width="390"> </td> </tr> </table> #### **Word assistant** > **Output:** editable Word (`.docx`) > Paper/thesis writing and production-ready document editing via the `docx` skill; powered by [OfficeCLI](https://github.com/iOfficeAI/OfficeCli). <table> <tr> <td align="center" width="50%"> <img src="./resources/readme-demo-generate-academic-paper.gif" alt="Generate academic paper demo" width="390"> </td> <td align="center" width="50%"> <img src="./resources/readme-demo-assistant-write-paper.gif" alt="Paper writing assistant demo" width="390"> </td> </tr> </table> #### **Excel assistant** > **Output:** usable Excel (`.xlsx/.xlsm/.csv`) > Generate/refresh spreadsheets with `xlsx` for analysis, auto-formatting, and charts; powered by [OfficeCLI](https://github.com/iOfficeAI/OfficeCli). <table> <tr> <td align="center" width="50%"> <img src="./resources/readme-demo-generate-excel.gif" alt="Excel generation demo" width="390"> </td> <td align="center" width="50%"> <img src="./resources/readme-demo-assistant-excel.gif" alt="Excel assistant demo" width="390"> </td> </tr> </table> --- ## Multi-Agent Mode — Already Have CLI Agents? Bring Them In If you already use Claude Code, Codex, Hermes Agent, or OpenClaw, AionUi auto-detects them and lets you Cowork with all of them — alongside the built-in agent. **Supported Agents:** Built-in Agent (zero setup) • Claude Code • Codex • Qwen Code • Goose AI • OpenClaw • Augment Code • CodeBuddy • Kimi CLI • OpenCode • Factory Droid • GitHub Copilot • Qoder CLI • Mistral Vibe • Nanobot • Aion CLI (aionrs, the Rust-based backend service shipped with AionUi) • Snow CLI • Hermes Agent • Cursor Agent and more <img src="./resources/multi-agent支持openclaw.gif" alt="Multi-Agent Cowork" width="800"> - **Auto Detection** — automatically recognizes installed CLI tools - **Unified Interface** — one Cowork platform for all your AI agents - **Parallel Sessions** — run multiple agents simultaneously with independent context - **MCP Unified Management** — configure MCP (Model Context Protocol) tools once, automatically sync to all agents — no need to configure each agent separately - **YOLO Mode** (auto-approve all agent actions without manual confirmation) / **Full-Auto Mode** — one click to bypass permission prompts; all agents support full-auto mode for unattended execution ### Team Mode — Coordinated Multi-Agent Collaboration Run multiple AI agents as an organized team: a **Leader** agent receives your instructions, breaks them into subtasks, and delegates to **Teammate** agents via a built-in Team MCP Server. Teammates execute in parallel, share results through an async mailbox, and write to a shared task board. <img src="./resources/AionUi_team.gif" alt="Team Mode overview" width="800"> - **Parallel multi-agent execution** — Leader breaks tasks into subtasks and delegates to Teammate agents running in parallel; each Teammate uses its own model via ACP (Agent Communication Protocol, AionUi's multi-agent coordination layer), Gemini, or Aionrs - **Leader orchestration** — Leader assigns, tracks, and aggregates results; supported backends include Claude Code, Codex, Hermes Agent, Gemini, Snow CLI, and Aion CLI - **Team-isolated workspace** — all agents share the same folder; each has its own permission dialog with sidebar badge for pending approvals <details> <summary>🔍 View Team Mode Details ▶️</summary> - **Shared Workspace** — all agents read/write the same folder; the file panel stays visible throughout - **Supported backends** — Claude Code, Codex, Gemini, Snow CLI, Aion CLI (aionrs); other ACP backends with `mcpCapabilities.stdio` are auto-supported - **Dynamic scaling** — add or remove Teammates while the team is running; silent agents auto-escalate to failed with one-click removal - **Granular permissions** — each agent has its own permission confirmation dialog; sidebar badge shows pending approvals - **File sharing** — Leader can pass file attachments to Teammates </details> --- ## Any API Key, Full Cowork Agent Power Other AI apps give you a chatbox with your API key. **AionUi gives you a full Cowork agent.** | Your API Key | What You Get | | :------------------------- | :------------------------------------------ | | Gemini API Key | Gemini-powered Cowork Agent | | OpenAI API Key | GPT-powered Cowork Agent | | Anthropic API Key | Claude-powered Cowork Agent | | AWS Bedrock credentials | Bedrock-powered Agent via Aion CLI (aionrs) | | Ollama / LM Studio (local) | Local model Cowork Agent | | NewAPI Gateway | Unified access to 20+ models | Same agent capabilities — file read/write, web search, image generation, tool use — regardless of which model powers it. AionUi supports **30+ AI platforms** including cloud services and local deployments. <img src="./resources/llm_newapi.png" alt="Multi-Model Support" width="800"> <details> <summary>🔍 View All 30+ Supported Platforms ▶️</summary> **Comprehensive Platform Support:** - **Official Platforms** — Gemini, Gemini (Vertex AI), Anthropic (Claude), OpenAI - **Cloud Providers** — AWS Bedrock, New API (unified AI model gateway) - **Chinese Platforms** — Dashscope (Qwen), Dashscope Coding Plan, Zhipu, Moonshot (Kimi), Qianfan (Baidu), Hunyuan (Tencent), Lingyi, ModelScope, InfiniAI, Ctyun, StepFun, SiliconFlow-CN, PPIO - **International Platforms** — DeepSeek, MiniMax, Novita, OpenRouter, SiliconFlow, xAI, Ark (Volcengine), Poe - **Local Models** — Ollama, LM Studio (via Custom platform with local API endpoint) AionUi also supports [NewAPI](https://github.com/QuantumNous/new-api) gateway service — a unified AI model hub that aggregates and distributes various LLMs. Flexibly switch between different models in the same interface to meet various task requirements. </details> --- ## Extensible Assistants & Skills _Extensible assistant system with 21 built-in professional assistants and a three-tier skill system. Create and manage your own assistants and skills._ - **Create Custom Assistants** — Define your own assistants with custom rules and capabilities - **Three-tier Skills** — Builtin skills (shipped with AionUi), custom skills (your own), and Extension skills (contributed by third-party extensions); enable/disable per conversation with the skill indicator - **Per-conversation Control** — A skill indicator in the chat header shows active skills for the current conversation; search and exclude skills as needed <img src="./resources/assitants.png" alt="AI Assistants & Skills Ecosystem" width="800"> AionUi supports three skill layers: **built-in** skills (shipped with the app), **custom** skills (user-defined), and **extension** skills (loaded from the Extension SDK). <details> <summary>🔍 View Assistant Details and Custom Skills ▶️</summary> AionUi includes **21 professional assistants** with predefined capabilities, extendable through custom skills: - **🤝 Cowork** — Autonomous task execution (file operations, document processing, workflow planning) - **📊 PPT Creator / Morph PPT / Morph PPT 3D** — Generate and animate PPTX presentations with Morph transitions - **📐 Pitch Deck Creator** — Investor-ready pitch deck generation - **📊 Dashboard Creator** — Data dashboard generation - **📝 Word Creator** — Production-ready Word (`.docx`) document generation - **📋 Word Form Creator** — Structured Word form / contract template generation - **📗 Excel Creator** — Spreadsheet generation with analysis, charts, and auto-formatting - **🎓 Academic Paper Writer** — Structured academic paper writing - **💰 Financial Model Creator** — Financial models and projections - **⭐ Star Office Helper** — Office productivity assistant - **🎮 3D Game** — Single-file 3D game generation - **🎨 UI/UX Pro Max** — Professional UI/UX design (57 styles, 95 color palettes) - **📋 Planning with Files** — File-based planning for complex tasks (Manus-style persistent markdown planning) - **🧭 HUMAN 3.0 Coach** — Personal development coach - **📣 Social Job Publisher** — Job posting and publishing - **🦞 moltbook** — Zero-deployment AI agent social networking - **📈 Beautiful Mermaid** — Flowcharts, sequence diagrams, and more - **🔧 OpenClaw Setup** — Setup and configuration assistant for OpenClaw integration - **📖 Story Roleplay** — Immersive story roleplay with character cards and world info (SillyTavern compatible) **Custom Skills**: Create skills in the `skills/` directory, enable/disable skills for assistants to extend AI capabilities. Skills come from three sources: builtin (shipped with AionUi), custom (your own), and Extension (contributed via the Extension SDK). Built-in skills include `pptx`, `docx`, `pdf`, `xlsx`, `mermaid`, and more. > 💡 Each assistant is defined by a markdown file. Check the `assistant/` directory for examples. </details> --- ## Cowork from Anywhere _Your 24/7 AI assistant — access AionUi from any device, anywhere._ - **WebUI Mode** — access via browser from phone, tablet, or any computer. Supports LAN, cross-network, and server deployment. QR code or password login. - **Chat Platform Integration** - **Telegram** — Cowork with your AI agent directly from Telegram - **Lark (Feishu)** — Cowork through Feishu bots for enterprise collaboration - **DingTalk** — AI Card streaming with automatic fallback - **WeChat** — Personal WeChat account integration - **WeCom (企业微信)**, **Slack**, **Discord** and more platforms coming soon > **Setup:** AionUi Settings → WebUI Settings → Channel, configure the Bot Token. <img src="./resources/webui-remote.gif" alt="WebUI remote access demo" width="800"> Remote control & monitor your agent — Claude, Gemini, Codex. Use from browser or phone, same as Claude Code remote. > [Remote Internet Access Tutorial](https://github.com/iOfficeAI/AionUi/wiki/Remote-Internet-Access-Guide-Chinese) ## ✨ Cowork in Action ### **Scheduled Tasks — Cowork on Autopilot** _Set it up once, the AI agent runs automatically on schedule — truly 24/7 unattended operation._ - **Natural Language** — tell the agent what to do, just like chatting - **Three scheduling modes** — standard cron expression (with timezone), fixed interval (every N minutes/hours), or one-time trigger - **AI-created tasks** — agents can autonomously create scheduled tasks during a conversation - **Use Cases:** scheduled data aggregation, report generation, file organization, reminders <img src="./resources/alart-task.png" alt="Scheduled Tasks" width="800"> <details> <summary>🔍 View Scheduled Task Details ▶️</summary> **Scheduling modes:** - `Cron expression` — standard 5-field cron with timezone support (e.g. `0 9 * * 1`, `Asia/Shanghai`) - `Every N minutes/hours` — fixed interval, e.g. run every 30 minutes - `One-time` — trigger once at a specified datetime, then auto-disable **Execution modes:** - `Continue in existing conversation` — appends to the bound conversation so the AI retains full context history - `Create new conversation each time` — opens a fresh session on each trigger, ideal for independent periodic reports **Other capabilities:** - **Conversation-Bound** — Each scheduled task is bound to a conversation, maintaining context and history - **Automatic Execution** — Tasks run automatically at scheduled times, sending messages to the conversation - **Easy Management** — Create, modify, enable/disable, delete, and view scheduled tasks anytime - **Keep-awake** — AionUi automatically prevents system sleep while tasks are active, and detects missed triggers after wake - **Advanced config** — each task can have its own model, workspace directory, and reasoning effort settings **Real-World Examples:** - Daily weather report generation - Weekly sales data aggregation - Monthly backup file organization - Custom reminder notifications </details> --- ### **Preview Panel — Instantly View AI-Generated Results** _10+ formats: PDF, Word, Excel, PPT, code, Markdown, images, HTML, Diff — view everything without switching apps._ - **Instant Preview** — after the agent generates files, view results immediately without switching apps - **Real-time Tracking + Editable** — automatically tracks file changes; supports live editing of Markdown, code, HTML - **Multi-Tab Support** — open multiple files simultaneously, each in its own tab - **Version History** — view and restore historical versions of files (Git-based) <img src="./resources/preview.gif" alt="Preview Panel" width="800"> <details> <summary>🔍 View Complete Format List ▶️</summary> **Supported Preview Formats:** - **Documents** — PDF, Word (`.doc`, `.docx`, `.odt`), Excel (`.xls`, `.xlsx`, `.ods`, `.csv`), PowerPoint (`.ppt`, `.pptx`, `.odp`) - **Code** — JavaScript, TypeScript, Python, Java, Go, Rust, C/C++, CSS, JSON, XML, YAML, Shell scripts, and 30+ programming languages - **Markup** — Markdown (`.md`, `.markdown`), HTML (`.html`, `.htm`) - **Images** — PNG, JPG, JPEG, GIF, SVG, WebP, BMP, ICO, TIFF, AVIF - **Other** — Diff files (`.diff`, `.patch`) </details> --- ### **Smart File Management — Automated File Operations** _Batch renaming, automatic organization, smart classification, file merging — the Cowork agent handles it for you._ <img src="./resources/aionui sort file 2.gif" alt="Smart File Management" width="800"> <details> <summary>🔍 View File Management Features Details ▶️</summary> - **Auto Organize** — Intelligently identify content and auto-classify, keeping folders tidy - **Efficient Batch** — One-click rename, merge files, say goodbye to tedious manual tasks - **Automated Execution** — AI agents can independently execute file operations, read/write files, and complete tasks automatically **Use Cases:** - Organize messy download folders by file type - Batch rename photos with meaningful names - Merge multiple documents into one - Auto-classify files by content </details> --- ### **Excel Data Processing — AI-Powered Analysis** _Deeply analyze Excel data, automatically beautify reports, and generate insights — all powered by AI agents._ <img src="./resources/generate_xlsx.gif" alt="Excel Processing" width="800"> <details> <summary>🔍 View Excel Processing Features ▶️</summary> - **Smart Analysis** — AI analyzes data patterns and generates insights - **Auto Formatting** — Automatically beautify Excel reports with professional styling - **Data Transformation** — Convert, merge, and restructure data with natural language commands - **Report Generation** — Create comprehensive reports from raw data **Use Cases:** - Analyze sales data and generate monthly reports - Clean and format messy Excel files - Merge multiple spreadsheets intelligently - Create data visualizations and charts </details> --- ### **AI Image Generation & Editing** _Intelligent image generation, editing, and recognition, powered by Gemini_ <img src="./resources/Image_Generation.gif" alt="AI Image Generation" width="800"> <details> <summary>🔍 View Image Generation Features ▶️</summary> - **Text-to-Image** — Generate images from natural language descriptions - **Image Editing** — Modify and enhance existing images - **Image Recognition** — Analyze and describe image content - **Batch Processing** — Generate multiple images at once </details> > [Image generation model configuration guide](https://github.com/iOfficeAI/AionUi/wiki/AionUi-Image-Generation-Tool-Model-Configuration-Guide) --- ### **Document Generation — PPT, Word, Markdown** _Automatically generate professional documents — presentations, reports, and more — with AI agents._ <img src="./resources/file_generation_preview.png" alt="Document Generation" width="800"> <details> <summary>🔍 View Document Generation Features ▶️</summary> - **PPTX Generator** — Create professional presentations from outlines or topics - **Word Documents** — Generate formatted Word documents with proper structure - **Markdown Files** — Create and format Markdown documents for documentation - **PDF Conversion** — Convert between various document formats **Use Cases:** - Generate quarterly business presentations - Create technical documentation - Convert PDF to editable formats - Auto-format research papers </details> ### **Personalized Interface Customization** _Customize with your own CSS code, make your interface match your preferences_ <img src="./resources/css with skin.gif" alt="CSS Customization" width="800"> - ✅ **Fully Customizable** — Freely customize interface colors, styles, layout through CSS code, create your exclusive experience --- ### **Multi-Task Parallel Processing** _Open multiple conversations, tasks don't get mixed up, independent memory, double efficiency_ <img src="./resources/multichat-side-by-side.gif" alt="Multi-Task Parallel" width="800"> - ✅ **Independent Context** — Each conversation maintains its own context and history - ✅ **Parallel Execution** — Run multiple tasks simultaneously without interference - ✅ **Smart Management** — Easy switching between conversations with visual indicators --- ## 🤔 Why Choose AionUi Over Claude Cowork? <details> <summary>Click to see detailed comparison</summary> AionUi is a **free and open-source Multi-AI Agent Desktop**. Compared to Claude Cowork which only runs on macOS and is locked to Claude, AionUi is its full-model, cross-platform enhanced version. | Dimension | Claude Cowork | AionUi | | :------------ | :------------ | :-------------------------------------------------------- | | OS | macOS Only | macOS / Windows / Linux | | Model Support | Claude Only | Gemini, Claude, DeepSeek, OpenAI, Ollama, ... | | Interaction | Desktop GUI | Desktop GUI + WebUI + Telegram / Lark / DingTalk / WeChat | | Automation | Manual only | Cron scheduled tasks — 24/7 unattended | | Cost | $100/month | Free & Open Source | Deep AI Office Scenario Support: - **File Management**: Intelligently organize local folders and batch rename with one click. - **Data Processing**: Deeply analyze and automatically beautify Excel reports. - **Document Generation**: Automatically write and format PPT, Word, and Markdown documents. - **Instant Preview**: Built-in 10+ format preview panels, AI collaboration results instantly visible. </details> --- ## Quick Q&A <details> <summary>Q: Do I need to install Gemini CLI or Claude Code first?</summary> A: No. AionUi has a built-in AI agent that works immediately after installation. Just enter any API key to get started. If you also have CLI tools like Claude Code or Gemini CLI installed, AionUi will auto-detect and integrate them for even more capabilities. </details> <details> <summary>Q: What can I do with AionUi?</summary> A: AionUi is your private Cowork workspace. The built-in agent can batch organize folders, process Excel data, generate documents, search the web, and generate images. With Multi-Agent Mode, you can also leverage Claude Code, Codex, and other powerful CLI agents through the same interface. </details> <details> <summary>Q: Is it free?</summary> A: AionUi is completely free and open source. You only pay for the API usage of whichever provider you choose, and you can use API keys from any provider you prefer. </details> <details> <summary>Q: Can I run AionUi on a server (headless)?</summary> A: Yes — AionUi WebUI mode runs as a standalone HTTP server. See the WebUI section above for setup instructions. </details> <details> <summary>Q: Is my data secure?</summary> A: All data is stored locally in a SQLite database. Nothing is uploaded to any server. </details> --- ## See How People Use AionUi <a href="https://www.youtube.com/watch?v=vWxE6VO9TKo" target="_blank"> <img src="https://img.youtube.com/vi/vWxE6VO9TKo/maxresdefault.jpg" alt="Hermes + Aion UI is Insane (FREE)!" width="400"> </a>    <a href="https://www.youtube.com/watch?v=RgSLdOhICZw" target="_blank"> <img src="https://img.youtube.com/vi/RgSLdOhICZw/maxresdefault.jpg" alt="OpenClaw + Aion UI is Insane (FREE!)" width="400"> </a> Julian Goldie SEO — Hermes + Aion UI is Insane (FREE!) · 27K views        Julian Goldie SEO — OpenClaw + Aion UI is Insane (FREE!) · 11K views <a href="https://www.youtube.com/watch?v=yUU5E-U5B3M" target="_blank"> <img src="https://img.youtube.com/vi/yUU5E-U5B3M/maxresdefault.jpg" alt="WorldofAI Review" width="400"> </a>    <a href="https://www.youtube.com/watch?v=enQnkKfth10" target="_blank"> <img src="https://img.youtube.com/vi/enQnkKfth10/maxresdefault.jpg" alt="Julian Goldie SEO Review" width="400"> </a> WorldofAI (200K subscribers)                                          Julian Goldie SEO (384K subscribers) ### Community Articles - [Open-source free Cowork, full model integration + autonomous file operations](https://mp.weixin.qq.com/s/F3f-CCsVPaK3lK00jXhOOg) — Open Source AI Project Landing - [Making ordinary people use Claude Code like an APP](https://mp.weixin.qq.com/s/TsMojSbkUUFvsd-HQCazZg) — Lazy Cat Loves Fishing - [5500 Stars: How Open Source Breaks Anthropic's AI Tool Moat](https://mp.weixin.qq.com/s/saEk49cYV6MqBgw19Lw6Gw) — AI Silicon Moment > **Made a video about AionUi?** [Let us know on X](https://x.com/AionUi) and we'll feature it here! --- ## 🚀 Quick Start ### System Requirements - **macOS**: 10.15 or higher - **Windows**: Windows 10 or higher - **Linux**: Ubuntu 18.04+ / Debian 10+ / Fedora 32+ - **Memory**: 4GB+ recommended - **Storage**: 500MB+ available space ### Install <a href="https://github.com/iOfficeAI/AionUi/releases"> <img src="https://img.shields.io/badge/Download-Latest%20Release-32CD32?style=for-the-badge&logo=github&logoColor=white" alt="Download Latest Release" height="50"> </a> Click the button above to go to the Releases page and download the installer for your platform (macOS / Windows / Linux). ```bash # Alternatively, macOS via Homebrew brew install aionui ``` ### Get Started in 3 Steps 1. **Install** AionUi 2. **Enter** any API key to get started 3. **Start Coworking** — the built-in AI agent is ready to go ### 📖 Detailed Guides <details> <summary>📖 Expand to View Complete Usage Guide</summary> **🚀 Quick Start** - [📖 Complete Installation Guide](https://github.com/iOfficeAI/AionUi/wiki/Getting-Started) — Detailed steps from download to configuration - [⚙️ LLM Configuration Guide](https://github.com/iOfficeAI/AionUi/wiki/LLM-Configuration) — Multi-platform AI model configuration - [🤖 Multi-Agent Mode Setup](https://github.com/iOfficeAI/AionUi/wiki/ACP-Setup) — Integrate terminal AI agents - [🔌 MCP Tool Configuration](https://github.com/iOfficeAI/AionUi/wiki/MCP-Configuration-Guide) — Model Context Protocol server setup - [🌐 WebUI Configuration Guide](https://github.com/iOfficeAI/AionUi/wiki/WebUI-Configuration-Guide) — Complete WebUI setup and configuration tutorial **🎯 Use Cases** - [📁 File Management](https://github.com/iOfficeAI/AionUi/wiki/file-management) — Smart file organization - [📊 Excel Processing](https://github.com/iOfficeAI/AionUi/wiki/excel-processing) — AI-driven data processing - [🎨 Image Generation](https://github.com/iOfficeAI/AionUi/wiki/AionUi-Image-Generation-Tool-Model-Configuration-Guide) — AI image creation - [📚 More Use Cases](https://github.com/iOfficeAI/AionUi/wiki/Use-Cases-Overview) **❓ Support & Help** - [❓ FAQ](https://github.com/iOfficeAI/AionUi/wiki/FAQ) — Questions and troubleshooting - [🔧 Configuration & Usage Tutorials](https://github.com/iOfficeAI/AionUi/wiki/Configuration-Guides) — Complete configuration documentation </details> --- ## 💬 Community & Support **Your ideas matter!** We value every suggestion and feedback. <a href="https://x.com/AionUi" target="_blank"> <img src="./resources/contactus-x.png" alt="Contact Us on X" width="600"> </a> - [GitHub Discussions](https://github.com/iOfficeAI/AionUi/discussions) — share ideas and exchange tips - [Report Issues](https://github.com/iOfficeAI/AionUi/issues) — bugs and feature requests - [Release Updates](https://github.com/iOfficeAI/AionUi/releases) — get the latest version - [Discord Community](https://discord.gg/2QAwJn7Egx) — English community - [WeChat Group](./resources/wx-11.png) — Chinese community ### Contributing Please read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a PR. 1. Fork this project 2. Create a feature branch (`git checkout -b feature/AmazingFeature`) 3. Commit your changes (`git commit -m 'Add some AmazingFeature'`) 4. Push to the branch (`git push origin feature/AmazingFeature`) 5. Open a Pull Request ### Development Setup Tech stack: Electron · Vite · React · Bun ```bash bun install # install dependencies bun run dev # start dev server bun run test # run unit tests ``` --- ## License This project is licensed under [Apache-2.0](LICENSE). --- ## Contributors <a href="https://github.com/iOfficeAI/AionUi/graphs/contributors"> <img src="https://contrib.rocks/image?repo=iOfficeAI/AionUi&max=100" alt="Contributors" /> </a> ## Star History <a href="https://www.star-history.com/#iOfficeAI/aionui&Date" target="_blank"> <img src="https://api.star-history.com/svg?repos=iOfficeAI/aionui&type=Date" alt="Star History" width="600"> </a> <div align="center"> **If you like it, give us a star** [Report Bug](https://github.com/iOfficeAI/AionUi/issues) · [Request Feature](https://github.com/iOfficeAI/AionUi/issues) </div> <a href="https://linux.do/">LINUX DO - A New Ideal Community</a>

AI Agents LLM Tools & Chat UIs

27.9K Github Stars

Open Source

OfficeCLI

# OfficeCLI > **OfficeCLI is the world's first and the best Office suite designed for AI agents.** **Give any AI agent full control over Word, Excel, and PowerPoint — in one line of code.** Open-source. Single binary. No Office installation. No dependencies. Works everywhere. **Built-in agent-friendly rendering engine** — agents can *see* what they create, no Office required. Render `.docx` / `.xlsx` / `.pptx` to HTML or PNG, closing the *render → look → fix* loop anywhere the binary runs. [![GitHub Release](https://img.shields.io/github/v/release/iOfficeAI/OfficeCLI)](https://github.com/iOfficeAI/OfficeCLI/releases) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE) **English** | [中文](README_zh.md) | [日本語](README_ja.md) | [한국어](README_ko.md) 💬 Community: <a href="https://discord.gg/2QAwJn7Egx" target="_blank">Discord</a> <img src="assets/ppt-process.webp" alt="OfficeCLI creating a PowerPoint presentation on AionUi" width="100%"> PPT creation process using OfficeCLI on <a href="https://github.com/iOfficeAI/AionUi">AionUi</a> PowerPoint Presentations <table> <tr> <td width="33%"><img src="assets/designwhatmovesyou.gif" alt="OfficeCLI design presentation (PowerPoint)"></td> <td width="33%"><img src="assets/horizon.gif" alt="OfficeCLI business presentation (PowerPoint)"></td> <td width="33%"><img src="assets/efforless.gif" alt="OfficeCLI tech presentation (PowerPoint)"></td> </tr> <tr> <td width="33%"><img src="assets/blackhole.gif" alt="OfficeCLI space presentation (PowerPoint)"></td> <td width="33%"><img src="assets/first-ppt-aionui.gif" alt="OfficeCLI gaming presentation (PowerPoint)"></td> <td width="33%"><img src="assets/shiba.gif" alt="OfficeCLI creative presentation (PowerPoint)"></td> </tr> </table> — Word Documents <table> <tr> <td width="33%"><img src="assets/showcase/word1.gif" alt="OfficeCLI academic paper (Word)"></td> <td width="33%"><img src="assets/showcase/word2.gif" alt="OfficeCLI project proposal (Word)"></td> <td width="33%"><img src="assets/showcase/word3.gif" alt="OfficeCLI annual report (Word)"></td> </tr> </table> — Excel Spreadsheets <table> <tr> <td width="33%"><img src="assets/showcase/excel1.gif" alt="OfficeCLI budget tracker (Excel)"></td> <td width="33%"><img src="assets/showcase/excel2.gif" alt="OfficeCLI gradebook (Excel)"></td> <td width="33%"><img src="assets/showcase/excel3.gif" alt="OfficeCLI sales dashboard (Excel)"></td> </tr> </table> All documents above were created entirely by AI agents using OfficeCLI — no templates, no manual editing. ## For AI Agents — Get Started in One Line Paste this into your AI agent's chat — it will read the skill file and install everything automatically: ``` curl -fsSL https://officecli.ai/SKILL.md ``` That's it. The skill file teaches the agent how to install the binary and use all commands. ## For Humans **Option A — GUI:** Install [**AionUi**](https://github.com/iOfficeAI/AionUi) — a desktop app that lets you create and edit Office documents through natural language, powered by OfficeCLI under the hood. Just describe what you want, and AionUi handles the rest. **Option B — CLI:** Download the binary for your platform from [GitHub Releases](https://github.com/iOfficeAI/OfficeCLI/releases), then run: ```bash officecli install ``` This copies the binary to your PATH and installs the **officecli skill** into every AI coding agent it detects — Claude Code, Cursor, Windsurf, GitHub Copilot, and more. Your agent can immediately create, read, and edit Office documents on your behalf, no extra configuration needed. ## For Developers — See It Live in 30 Seconds ```bash # 1. Install (macOS / Linux) curl -fsSL https://raw.githubusercontent.com/iOfficeAI/OfficeCLI/main/install.sh | bash # Windows (PowerShell): irm https://raw.githubusercontent.com/iOfficeAI/OfficeCLI/main/install.ps1 | iex # 2. Create a blank PowerPoint officecli create deck.pptx # 3. Start live preview — opens http://localhost:26315 in your browser officecli watch deck.pptx # 4. Open another terminal, add a slide — watch the browser update instantly officecli add deck.pptx / --type slide --prop title="Hello, World!" ``` That's it. Every `add`, `set`, or `remove` command you run will refresh the preview in real time. Keep experimenting — the browser is your live feedback loop. ## Quick Start ```bash # Create a presentation and add content officecli create deck.pptx officecli add deck.pptx / --type slide --prop title="Q4 Report" --prop background=1A1A2E officecli add deck.pptx '/slide[1]' --type shape \ --prop text="Revenue grew 25%" --prop x=2cm --prop y=5cm \ --prop font=Arial --prop size=24 --prop color=FFFFFF # View as outline officecli view deck.pptx outline # → Slide 1: Q4 Report # → Shape 1 [TextBox]: Revenue grew 25% # View as HTML — opens a rendered preview in your browser, no server needed officecli view deck.pptx html # Get structured JSON for any element officecli get deck.pptx '/slide[1]/shape[1]' --json # Save and close — flushes the resident session to disk officecli close deck.pptx ``` ```json { "tag": "shape", "path": "/slide[1]/shape[1]", "attributes": { "name": "TextBox 1", "text": "Revenue grew 25%", "x": "720000", "y": "1800000" } } ``` ## Why OfficeCLI? What used to take 50 lines of Python and 3 separate libraries: ```python from pptx import Presentation from pptx.util import Inches, Pt prs = Presentation() slide = prs.slides.add_slide(prs.slide_layouts[0]) title = slide.shapes.title title.text = "Q4 Report" # ... 45 more lines ... prs.save('deck.pptx') ``` Now takes one command: ```bash officecli add deck.pptx / --type slide --prop title="Q4 Report" ``` **What OfficeCLI can do:** - **Create** documents from scratch -- blank or with content - **Read** text, structure, styles, formulas -- in plain text or structured JSON - **Analyze** formatting issues, style inconsistencies, and structural problems - **Modify** any element -- text, fonts, colors, layout, formulas, charts, images - **Reorganize** content -- add, remove, move, copy elements across documents | Format | Read | Modify | Create | |--------|------|--------|--------| | Word (.docx) | ✅ | ✅ | ✅ | | Excel (.xlsx) | ✅ | ✅ | ✅ | | PowerPoint (.pptx) | ✅ | ✅ | ✅ | **Word** — full [i18n & RTL support](https://github.com/iOfficeAI/OfficeCLI/wiki/i18n) (per-script font slots, per-script BCP-47 lang tags `lang.latin/ea/cs`, complex-script bold/italic/size, `direction=rtl` cascading through paragraph/run/section/table/style/header/footer/docDefaults, `rtlGutter` + `pgBorders` shorthand, locale-aware page numbering for Hindi/Arabic/Thai/CJK), [paragraphs](https://github.com/iOfficeAI/OfficeCLI/wiki/word-paragraph), [runs](https://github.com/iOfficeAI/OfficeCLI/wiki/word-run), [tables](https://github.com/iOfficeAI/OfficeCLI/wiki/word-table), [styles](https://github.com/iOfficeAI/OfficeCLI/wiki/word-style), [headers/footers](https://github.com/iOfficeAI/OfficeCLI/wiki/word-header-footer), [images](https://github.com/iOfficeAI/OfficeCLI/wiki/word-picture) (PNG/JPG/GIF/SVG), [equations](https://github.com/iOfficeAI/OfficeCLI/wiki/word-equation), [comments](https://github.com/iOfficeAI/OfficeCLI/wiki/word-comment), [footnotes](https://github.com/iOfficeAI/OfficeCLI/wiki/word-footnote), [watermarks](https://github.com/iOfficeAI/OfficeCLI/wiki/word-watermark), [bookmarks](https://github.com/iOfficeAI/OfficeCLI/wiki/word-bookmark), [TOC](https://github.com/iOfficeAI/OfficeCLI/wiki/word-toc), [charts](https://github.com/iOfficeAI/OfficeCLI/wiki/word-chart), [hyperlinks](https://github.com/iOfficeAI/OfficeCLI/wiki/word-hyperlink), [sections](https://github.com/iOfficeAI/OfficeCLI/wiki/word-section), [form fields](https://github.com/iOfficeAI/OfficeCLI/wiki/word-formfield), [content controls (SDT)](https://github.com/iOfficeAI/OfficeCLI/wiki/word-sdt), [fields](https://github.com/iOfficeAI/OfficeCLI/wiki/word-field) (22 zero-param types + MERGEFIELD / REF / PAGEREF / SEQ / STYLEREF / DOCPROPERTY / IF), [OLE objects](https://github.com/iOfficeAI/OfficeCLI/wiki/word-ole), [document properties](https://github.com/iOfficeAI/OfficeCLI/wiki/word-document) **Excel** — [cells](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-cell) (phonetic guide / furigana on add), formulas (150+ built-in functions with auto-evaluation, `_xlfn.` auto-prefix for dynamic-array functions), [sheets](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-sheet) (visible/hidden/veryHidden, print margins, printTitleRows/Cols, RTL `sheetView`, cascade-aware sheet rename), [tables](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-table), [sort](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-sort) (sheet / range, multi-key, sidecar-aware), [conditional formatting](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-conditionalformatting), [charts](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-chart) (including box-whisker, [pareto](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-chart-add) with auto-sort + cumulative-%, log axis), [pivot tables](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-pivottable) (multi-field, date grouping, showDataAs, sort, grandTotals, subtotals, compact/outline/tabular layout, repeat item labels, blank rows, calculated fields), [slicers](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-slicer), [named ranges](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-namedrange), [data validation](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-validation), [images](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-picture) (PNG/JPG/GIF/SVG with dual-representation fallback), [sparklines](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-sparkline), [comments](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-comment) (RTL), [autofilter](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-autofilter), [shapes](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-shape), [OLE objects](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-ole), CSV/TSV import, `$Sheet:A1` cell addressing **PowerPoint** — [slides](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-slide) (header/footer/date/slidenum toggles, hidden), [shapes](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-shape) (pattern fill, blur effect, hyperlink tooltip + slide-jump links), [images](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-picture) (PNG/JPG/GIF/SVG, fill modes: stretch/contain/cover/tile, brightness/contrast/glow/shadow), [tables](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-table), [charts](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-chart), [animations](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-slide), [morph transitions](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-morph-check), [3D models (.glb)](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-3dmodel), [slide zoom](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-zoom), [equations](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-equation), [themes](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-theme), [connectors](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-connector), [video/audio](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-video), [groups](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-group), [notes](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-notes) (RTL, lang), [comments](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-comment) (RTL), [OLE objects](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-ole), [placeholders](https://github.com/iOfficeAI/OfficeCLI/wiki/ppt-placeholder) (add/set by phType) ## Use Cases **For Developers:** - Automate report generation from databases or APIs - Batch-process documents (bulk find/replace, style updates) - Build document pipelines in CI/CD environments (generate docs from test results) - Headless Office automation in Docker/containerized environments **For AI Agents:** - Generate presentations from user prompts (see examples above) - Extract structured data from documents to JSON - Validate and check document quality before delivery **For Teams:** - Clone document templates and populate with data - Automated document validation in CI/CD pipelines ## Installation Ships as a single self-contained binary. The .NET runtime is embedded -- nothing to install, no runtime to manage. **One-line install:** ```bash # macOS / Linux curl -fsSL https://raw.githubusercontent.com/iOfficeAI/OfficeCLI/main/install.sh | bash # Windows (PowerShell) irm https://raw.githubusercontent.com/iOfficeAI/OfficeCLI/main/install.ps1 | iex ``` **Or download manually** from [GitHub Releases](https://github.com/iOfficeAI/OfficeCLI/releases): | 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` | Verify installation: `officecli --version` **Or self-install from a downloaded binary (or run bare `officecli` to auto-install):** ```bash officecli install # explicit officecli # bare invocation also triggers install ``` Updates are checked automatically in the background. Disable with `officecli config autoUpdate false` or skip per-invocation with `OFFICECLI_SKIP_UPDATE=1`. Configuration lives under `~/.officecli/config.json`. ## Key Features ### Built-in Engines & Generation Primitives OfficeCLI is self-contained. The capabilities below ship inside the binary — **no Office required**. #### Rendering engine A from-scratch agent-friendly rendering engine ships in the binary itself, covering shapes, charts (trendlines, error bars, waterfall, candlestick, sparklines), equations (OMML → MathJax-compatible), 3D `.glb` models via Three.js, morph transitions, slide zoom, and shape effects. Per-page PNG screenshots are produced by piping the rendered HTML through a headless browser. Three modes: - **`view html`** — standalone HTML file, assets inlined. Open in any browser. - **`view screenshot`** — per-page PNG, ready for multimodal agents to read. - **`watch`** — local HTTP server with auto-refreshing preview; every `add` / `set` / `remove` updates the browser instantly. Excel watch supports inline cell editing and drag-to-reposition charts. ```bash officecli view deck.pptx html -o /tmp/deck.html officecli view deck.pptx screenshot -o /tmp/deck.png # add --page 1-N for more slides officecli watch deck.pptx # http://localhost:26315 ``` > Without visualization, an agent generating slides is flying blind — it can read the DOM but can't tell if the title overflows or two shapes overlap. Because rendering is built into the binary, the *render → look → fix* loop works in CI, in Docker, on a server with no display — anywhere the binary runs. #### Formula & pivot engine 150+ built-in Excel functions evaluated automatically on write — write `=SUM(A1:A2)`, `get` the cell, the value is already there. No round-trip through Office to recalc. Covers dynamic-array functions (`FILTER` / `UNIQUE` / `SORT` / `SEQUENCE` with auto `_xlfn.` prefix), `VLOOKUP` / `INDEX` / `MATCH`, date & text functions, and 140+ more. Plus native OOXML pivot tables from a source range with one command — multi-field rows/cols/filters, 10 aggregations, `showDataAs` modes, date grouping, calculated fields, top-N, layouts. Pivot cache + definition are written to OOXML, so Excel opens the file with the aggregation already populated: ```bash officecli add sales.xlsx '/Sheet1' --type pivottable \ --prop source='Data!A1:E10000' --prop rows='Region,Category' \ --prop cols=Quarter --prop values='Revenue:sum,Units:avg' \ --prop showDataAs=percentOfTotal ``` #### Template merge — generate once, fill many `merge` replaces `{{key}}` placeholders in any `.docx` / `.xlsx` / `.pptx` with JSON data — across paragraphs, table cells, shapes, headers, footers, and chart titles. Agent designs the layout once (expensive); production code fills it N times (cheap, deterministic, zero token cost). Avoids the failure mode where an agent regenerates each report from scratch and produces N inconsistent layouts. ```bash officecli merge invoice-template.docx out-001.docx '{"client":"Acme","total":"$5,200"}' officecli merge q4-template.pptx q4-acme.pptx data.json ``` #### Round-trip dump — learn from existing docs `dump` serializes any `.docx` — whole document **or any subtree** (a single paragraph, table, the styles part, numbering, theme, or settings) — into a replayable batch JSON; `batch` replays it. Given a sample the user wants to imitate, an agent reads the structured spec instead of raw OOXML XML, mutates, and replays. Bridges "I have an existing template" and "generate me 100 variations." ```bash officecli dump existing.docx -o blueprint.json # whole document officecli dump existing.docx /body/tbl[1] -o table.json # any subtree officecli batch new.docx --input blueprint.json ``` ### Resident Mode & Batch For multi-step workflows, resident mode keeps the document in memory. Batch mode runs multiple operations in one open/save cycle. ```bash # Resident mode — near-zero latency via named pipes officecli open report.docx officecli set report.docx /body/p[1]/r[1] --prop bold=true officecli set report.docx /body/p[2]/r[1] --prop color=FF0000 officecli close report.docx # Batch mode — atomic multi-command execution (stops on first error by default) echo '[{"command":"set","path":"/slide[1]/shape[1]","props":{"text":"Hello"}}, {"command":"set","path":"/slide[1]/shape[2]","props":{"fill":"FF0000"}}]' \ | officecli batch deck.pptx --json # Inline batch with --commands (no stdin needed) officecli batch deck.pptx --commands '[{"op":"set","path":"/slide[1]/shape[1]","props":{"text":"Hi"}}]' # Use --force to continue past errors officecli batch deck.pptx --input updates.json --force --json ``` ### Three-Layer Architecture Start simple, go deep only when needed. | 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` | ```bash # L1 — high-level views officecli view report.docx annotated officecli view budget.xlsx text --cols A,B,C --max-lines 50 # L2 — element-level operations officecli query report.docx "run:contains(TODO)" officecli add budget.xlsx / --type sheet --prop name="Q2 Report" officecli move report.docx /body/p[5] --to /body --index 1 # L3 — raw XML when L2 isn't enough officecli raw deck.pptx '/slide[1]' officecli raw-set report.docx document \ --xpath "//w:p[1]" --action append \ --xml '<w:r><w:t>Injected text</w:t></w:r>' ``` ## AI Integration ### MCP Server Built-in [MCP](https://modelcontextprotocol.io) server — register with one command: ```bash officecli mcp claude # Claude Code officecli mcp cursor # Cursor officecli mcp vscode # VS Code / Copilot officecli mcp lmstudio # LM Studio officecli mcp list # Check registration status ``` Exposes all document operations as tools over JSON-RPC — no shell access needed. ### Direct CLI Integration Get OfficeCLI working with your AI agent in two steps: 1. **Install the binary** -- one command (see [Installation](#installation)) 2. **Done.** OfficeCLI automatically detects your AI tools (Claude Code, GitHub Copilot, Codex) by checking known config directories and installs its skill file. Your agent can immediately create, read, and modify any Office document. <details> <summary>Manual setup (optional)</summary> If auto-install doesn't cover your setup, you can install the skill file manually: **Feed SKILL.md to your agent directly:** ```bash curl -fsSL https://officecli.ai/SKILL.md ``` **Install as a local skill for Claude Code:** ```bash curl -fsSL https://officecli.ai/SKILL.md -o ~/.claude/skills/officecli.md ``` **Other agents:** Include the contents of `SKILL.md` in your agent's system prompt or tool description. </details> ### Why your agent will thrive on OfficeCLI - **Deterministic JSON output** — every command supports `--json` with consistent schemas. No regex parsing, no scraping stdout. - **Path-based addressing** — every element has a stable path (`/slide[1]/shape[2]`). Agents navigate documents without understanding XML namespaces. (OfficeCLI syntax: 1-based indexing, element local names — not XPath.) - **Progressive complexity (L1 → L2 → L3)** — agents start with read-only views, escalate to DOM ops, fall back to raw XML only when needed. Minimizes token usage. - **Self-healing workflow** — `validate`, `view issues`, and the structured error codes (`not_found`, `invalid_value`, `unsupported_property`) return suggestions and valid ranges. Agents self-correct without human intervention. - **Built-in agent-friendly rendering engine** — `view html` / `view screenshot` / `watch` emit HTML and PNG natively. No Office required. Agents can *see* their output and fix layout issues, even inside CI / Docker / headless environments. - **Built-in formula & pivot engine** — 150+ Excel functions auto-evaluated on write; native OOXML pivot tables from a source range with one command. Agents read computed values and shipped aggregations immediately, without round-tripping through Office. - **Template merge** — agent designs the layout once, downstream code fills `{{key}}` placeholders N times. Avoids burning tokens regenerating every report from scratch. - **Round-trip dump** — `dump` turns any `.docx` into replayable batch JSON. Agents learn from human-authored samples by reading a structured spec, not raw OOXML XML. - **Built-in help** — when unsure about property names or value formats, the agent runs `officecli <format> set <element>` instead of guessing. - **Auto-install** — OfficeCLI detects your AI tooling (Claude Code, Cursor, VS Code, …) and configures itself. No manual skill-file setup. ### Built-in Help Don't guess property names — drill into the help: ```bash officecli pptx set # All settable elements and properties officecli pptx set shape # Detail for one element type officecli pptx set shape.fill # One property: format and examples officecli docx query # Selector reference: attributes, :contains, :has(), etc. ``` Run `officecli --help` for the full overview. ### JSON Output Schemas All commands support `--json`. The general response shapes: **Single element** (`get --json`): ```json {"tag": "shape", "path": "/slide[1]/shape[1]", "attributes": {"name": "TextBox 1", "text": "Hello"}} ``` **List of elements** (`query --json`): ```json [ {"tag": "paragraph", "path": "/body/p[1]", "attributes": {"style": "Heading1", "text": "Title"}}, {"tag": "paragraph", "path": "/body/p[5]", "attributes": {"style": "Heading1", "text": "Summary"}} ] ``` **Errors** return a non-zero exit code with a structured error object including error code, suggestion, and valid values when available: ```json { "success": false, "error": { "error": "Slide 50 not found (total: 8)", "code": "not_found", "suggestion": "Valid Slide index range: 1-8" } } ``` Error codes: `not_found`, `invalid_value`, `unsupported_property`, `invalid_path`, `unsupported_type`, `missing_property`, `file_not_found`, `file_locked`, `invalid_selector`. Property names are auto-corrected -- misspelling a property returns a suggestion with the closest match. **Error Recovery** -- Agents self-correct by inspecting available elements: ```bash # Agent tries an invalid path officecli get report.docx /body/p[99] --json # Returns: {"success": false, "error": {"error": "...", "code": "not_found", "suggestion": "..."}} # Agent self-corrects by checking available elements officecli get report.docx /body --depth 1 --json # Returns the list of available children, agent picks the right path ``` **Mutation confirmations** (`set`, `add`, `remove`, `move`, `create` with `--json`): ```json {"success": true, "path": "/slide[1]/shape[1]"} ``` See `officecli --help` for full details on exit codes and error formats. ## Comparison | | 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 Reference | Command | Description | |---------|-------------| | [`create`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-create) | Create a blank .docx, .xlsx, or .pptx (type from extension) | | [`view`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-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`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-skills) | Print embedded SKILL.md content for a specialized skill (no install) | | [`get`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-get) | Get element and children (`--depth N`, `--json`) | | [`query`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-query) | CSS-like query with boolean `and`/`or`, row-by-column-name (`row[Salary>5000]`), `--find` flag | | [`set`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-set) | Modify element properties; accepts selectors and Excel-native paths (parity with `get`/`query`), `--find`/`--replace` flags | | [`add`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-add) | Add element (or clone with `--from <path>`) | | [`remove`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-remove) | Remove an element | | [`move`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-move) | Move element (`--to <parent>`, `--index N`, `--after <path>`, `--before <path>`) | | [`swap`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-swap) | Swap two elements | | [`validate`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-validate) | Validate against OpenXML schema | | `view <file> issues` | Enumerate document issues (text overflow, missing alt text, formula errors, ...) | | [`batch`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-batch) | Multiple operations in one open/save cycle (stdin, `--input`, or `--commands`; stops on first error, `--force` to continue) | | [`dump`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-dump) | Serialize a `.docx` or `.pptx` into a replayable batch JSON (round-trip via `batch`); accepts a subtree path | | [`refresh`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-refresh) | Recalculate TOC page numbers / `PAGE` / cross-references (`.docx`; Word backend on Windows, headless-HTML fallback) | | [`plugins`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-plugins) | List / inspect / lint installed plugins (extend to `.doc`, `.hwpx`, `.pdf` export via dump-reader / exporter / format-handler kinds) | | [`merge`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-merge) | Template merge — replace `{{key}}` placeholders with JSON data | | [`watch`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-watch) | Live HTML preview in browser with auto-refresh | | [`mcp`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-mcp) | Start MCP server for AI tool integration | | [`raw`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-raw) | View raw XML of a document part | | [`raw-set`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-raw) | Modify raw XML via XPath | | `add-part` | Add a new document part (header, chart, etc.) | | [`open`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-open) | Start resident mode (keep document in memory) | | `close` | Save and close resident mode | | [`install`](https://github.com/iOfficeAI/OfficeCLI/wiki/command-install) | Install binary + skills + MCP (`all`, `claude`, `cursor`, etc.) | | `config` | Get or set configuration | | `<format> <command>` | [Built-in help](https://github.com/iOfficeAI/OfficeCLI/wiki/command-reference) (e.g. `officecli pptx set shape`) | ## End-to-End Workflow Example A typical self-healing agent workflow: create a presentation, populate it, verify, and fix issues -- all without human intervention. ```bash # 1. Create officecli create report.pptx # 2. Add content officecli add report.pptx / --type slide --prop title="Q4 Results" officecli add report.pptx '/slide[1]' --type shape \ --prop text="Revenue: $4.2M" --prop x=2cm --prop y=5cm --prop size=28 officecli add report.pptx / --type slide --prop title="Details" officecli add report.pptx '/slide[2]' --type shape \ --prop text="Growth driven by new markets" --prop x=2cm --prop y=5cm # 3. Verify officecli view report.pptx outline officecli validate report.pptx # 4. Fix any issues found officecli view report.pptx issues --json # Address issues based on output, e.g.: officecli set report.pptx '/slide[1]/shape[1]' --prop font=Arial ``` ### Units & Colors All dimension and color properties accept flexible input formats: | 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%` | ## Common Patterns ```bash # Replace all Heading1 text in a Word doc officecli query report.docx "paragraph[style=Heading1]" --json | ... officecli set report.docx /body/p[1]/r[1] --prop text="New Title" # Export all slide content as JSON officecli get deck.pptx / --depth 2 --json # Bulk-update Excel cells officecli batch budget.xlsx --input updates.json --json # Import CSV data into an Excel sheet officecli add budget.xlsx / --type sheet --prop name="Q1 Data" --prop csv=sales.csv # Template merge for batch reports officecli merge invoice-template.docx invoice-001.docx '{"client":"Acme","total":"$5,200"}' # Check document quality before delivery officecli validate report.docx && officecli view report.docx issues --json ``` **From Python** — install the thin `officecli-sdk` (resident-pipe wrapper, no per-call process spawn) or wrap subprocess directly: ```python # Option A: thin SDK over the resident pipe from officecli import Doc with Doc("deck.pptx") as d: d.add("/", type="slide", title="Q4 Report") print(d.get("/slide[1]")) # Option B: subprocess wrapper (one-shot, no resident) import json, subprocess def cli(*args): return json.loads(subprocess.check_output(["officecli", *args, "--json"], text=True)) cli("create", "deck.pptx") ``` The SDK falls back to the default install dir when `officecli` is not on PATH. ## Documentation The [Wiki](https://github.com/iOfficeAI/OfficeCLI/wiki) has detailed guides for every command, element type, and property: - **By format:** [Word](https://github.com/iOfficeAI/OfficeCLI/wiki/word-reference) | [Excel](https://github.com/iOfficeAI/OfficeCLI/wiki/excel-reference) | [PowerPoint](https://github.com/iOfficeAI/OfficeCLI/wiki/powerpoint-reference) - **Workflows:** [End-to-end examples](https://github.com/iOfficeAI/OfficeCLI/wiki/workflows) -- Word reports, Excel dashboards, PowerPoint decks, batch modifications, resident mode - **Runnable examples:** [examples/](examples/) -- copy-paste scripts (.sh/.py) for Word, Excel, and PowerPoint, with output files included - **Troubleshooting:** [Common errors and solutions](https://github.com/iOfficeAI/OfficeCLI/wiki/troubleshooting) - **AI agent guide:** [Decision tree for navigating the wiki](https://github.com/iOfficeAI/OfficeCLI/wiki/agent-guide) ## Build from Source Requires [.NET 10 SDK](https://dotnet.microsoft.com/download) for compilation only. The output is a self-contained, native binary -- .NET is embedded in the binary and is not needed at runtime. ```bash ./build.sh ``` ## License [Apache License 2.0](LICENSE) Bug reports and contributions are welcome on [GitHub Issues](https://github.com/iOfficeAI/OfficeCLI/issues). --- If you find OfficeCLI useful, please [give it a star on GitHub](https://github.com/iOfficeAI/OfficeCLI) — it helps others discover the project. [OfficeCLI.AI](https://OfficeCLI.AI) | [GitHub](https://github.com/iOfficeAI/OfficeCLI)

AI Tools

6.6K Github Stars