Where to Find OfficeCLI Documentation: Complete Guide for iOfficeAI/OfficeCLI

All OfficeCLI documentation is located in the repository root (README.md and localized variants) and the examples/ directory containing runnable Bash and Python scripts.

The iOfficeAI/OfficeCLI repository provides a cross-platform command-line tool written in TypeScript/JavaScript for automating Microsoft Office tasks. Whether you are installing the CLI or integrating it into Python workflows, this guide shows you exactly where to find the official OfficeCLI documentation and hands-on code samples.

Repository Documentation Structure

The primary OfficeCLI documentation lives in the repository root, organized into multilingual README files that cover installation, CLI commands, and supported features.

Main README and Localization

• README.md – The primary English documentation containing overview, installation steps, quick-start commands, and supported Office actions.
• README_zh.md – Chinese translation of the main documentation.
• README_ja.md – Japanese translation of the main documentation.
• README_ko.md – Korean translation of the main documentation.

These files provide the same comprehensive content across languages, ensuring developers worldwide can access the OfficeCLI documentation in their preferred language.

Practical Examples Directory

Beyond static documentation, the examples/word/ directory contains executable scripts that serve as living documentation. These ready-to-run Bash and Python files demonstrate real-world usage of the CLI, including textbox creation, table manipulation, and paragraph formatting.

Adding Textboxes to Word Documents

The following Bash example creates a textbox in a Word document:

officecli word textbox --file examples/word/textbox.docx \
    --text "Hello, Office CLI!" \
    --left 100 --top 200 --width 300 --height 150

See the full script: examples/word/textbox.sh

Inserting Tables via Python

For Python developers, the tables.py example shows how to programmatically insert tables:

from officecli import OfficeCLI

cli = OfficeCLI()
cli.word.table(
    file="examples/word/tables.docx",
    rows=3,
    cols=4,
    style="LightShading-Accent1"
)

See the full script: examples/word/tables.py

Paragraph Formatting Commands

Apply paragraph styles using the Bash interface:

officecli word format-paragraph \
    --file examples/word/paragraph-formatting.docx \
    --style "Heading 2" \
    --alignment center

See the full script: examples/word/paragraph-formatting.sh

Complex Formatting Workflows

The run-formatting.py example demonstrates chaining multiple actions in a single workflow:

from officecli import OfficeCLI

cli = OfficeCLI()
cli.word.run_formatting(
    file="examples/word/run-formatting.docx",
    actions=[
        {"type": "textbox", "text": "Demo", "position": {"left": 50, "top": 50}},
        {"type": "table", "rows": 2, "cols": 3},
        {"type": "paragraph", "style": "Quote"},
    ]
)

See the full script: examples/word/run-formatting.py

Key Implementation Files

Developers needing to understand the CLI internals can examine these source files:

• npm/package.json – Defines the Node.js package configuration, scripts, and entry point.
• npm/officecli.js – The compiled CLI entry point that parses commands and dispatches operations.
• install.sh – Unix-like system installer.
• install.ps1 – Windows PowerShell installer.

These files reveal how the officecli command processes arguments like --file, --text, and --style before executing Word automation tasks.

Summary

• The primary OfficeCLI documentation resides in README.md with Chinese, Japanese, and Korean translations available.
• The examples/word/ directory contains executable Bash and Python scripts that demonstrate real-world CLI usage.
• Key source files like npm/officecli.js handle command parsing and dispatch.
• All documentation is viewable directly on GitHub with line numbers for precise reference.

Frequently Asked Questions

Where is the official OfficeCLI documentation hosted?

The official OfficeCLI documentation is hosted directly in the iOfficeAI/OfficeCLI GitHub repository. The root contains multilingual README files, while the examples/ directory houses executable scripts that serve as practical documentation for common automation tasks.

What languages does the OfficeCLI documentation support?

According to the repository source code, OfficeCLI documentation is available in English (README.md), Chinese (README_zh.md), Japanese (README_ja.md), and Korean (README_ko.md). All translations contain the same installation instructions and command references.

Can I run the OfficeCLI documentation examples locally?

Yes. The examples/word/ directory contains runnable scripts. Bash examples (.sh files) can be executed directly after installing the CLI via install.sh or install.ps1. Python examples require importing the officecli module and can be run with any Python interpreter.

What file contains the CLI entry point implementation?

The compiled CLI entry point is located at npm/officecli.js. This file processes command-line arguments and dispatches to the underlying TypeScript/JavaScript implementation that handles Word document manipulation.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}