Skip to content

officecli/officecli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OfficeCLI is an AI document generation CLI for PPTX, DOCX, XLSX, reports, and images

GitHub Release npm License Website Discord X

OfficeCLI is a command-line tool that turns natural-language prompts into editable Office files and standalone images from a terminal, script, CI job, or local automation flow. Use one officecli binary to generate PPTX, DOCX, XLSX, workbook-backed Report, and img outputs, with hosted trial access for first runs and External Mode when you want to bring your own LLM endpoint.

Chinese documentation: README.zh-CN.md

Install in one command

npm is the recommended install path for most users:

npm install -g officecli

Verify the installed binary:

officecli --version
officecli auth status

Alternative install paths are available when npm is not a good fit.

Install the latest release binary directly:

curl -fsSL https://raw.githubusercontent.com/officecli/officecli-dist/main/scripts/install-officecli.sh | bash

Or install with Homebrew:

brew tap officecli/officecli
brew install officecli

Generate files from the CLI

Hosted anonymous trial access is available by default, so the first run does not require a local model endpoint or API key.

Generate a PPTX deck:

officecli new pptx "Q3 Business Review" --prompt "Create a six-slide executive deck for a SaaS quarterly business review. Cover growth, retention, risks, and next-quarter actions."

Generate a DOCX:

officecli new docx "Product Launch Brief" --prompt "Write a concise launch brief with audience, positioning, timeline, risks, and next steps."

Generate an XLSX workbook:

officecli new xlsx "Sales Pipeline" --prompt "Create a sales pipeline workbook with stages, owners, deal values, probability, and next action columns."

Generate a workbook-backed report:

officecli new report "Q2 Business Review" --file ./data/q2_metrics.xlsx --prompt "Summarize regional revenue shifts and the board-level decision points."

Generate a standalone image:

officecli new img "Launch Visual" --prompt "Create a polished product launch hero image for an enterprise collaboration platform." --ratio landscape --reference-image ./reference.png

Generated files are written to ./output by default. Use --out <dir> to choose another directory, --json for machine-readable output, and --no-publish when you want local-only output.

For PPTX, OfficeCLI generates and embeds suitable images by default. Use --no-images for a text-only deck.

What OfficeCLI is best for

Search intent OfficeCLI capability
AI PPTX generator Create editable PowerPoint decks from prompts, with images by default and --no-images for text-only decks.
DOCX generator CLI Draft editable Word documents for briefs, memos, proposals, and customer-facing documents.
XLSX automation Generate workbooks, trackers, dashboards, and analysis sheets from structured prompts.
Report generation Use an existing workbook as evidence and generate a readable workbook-backed report.
Image generation CLI Generate standalone img outputs with --ratio square|landscape|portrait and optional reference images.
Local-first document automation Run from a terminal, script, CI job, or agent workflow with one installable binary.

Runtime and access modes

Check the current access mode:

officecli auth status

When the hosted trial is used up, create or purchase a hosted key from https://officecli.io/pricing, then save it:

officecli auth set-key <api-key>

To use your own model endpoint instead of Hosted Mode, switch to External Mode and initialize generation:

officecli config set-runtime external
officecli config set-generation

Configure optional online publishing:

officecli config set-publish

Inspect the current config:

officecli config status

What the binary supports

The officecli binary supports:

  • AI PPTX generation for decks, proposals, and executive briefings
  • AI DOCX drafting for retrospectives, memos, and customer-facing documents
  • AI XLSX generation for workbooks, trackers, and analysis sheets
  • workbook-backed reports
  • standalone image generation with --ratio square|landscape|portrait
  • optional reference images for standalone img output
  • local-only generation with --no-publish
  • structural PPTX scoring with officecli score pptx <file>

The compatibility alias remains available:

officecli review pptx ./output/Enterprise-Collaboration-Platform.pptx

Generation demos

These checked-in demos show the visible result and the reproducible inputs together. Each demo includes a preview image, the generated artifact, prompt.md, metadata.json, and the command used to reproduce the flow with a configured OfficeCLI runtime.

AI PPTX, DOCX, XLSX, report, and image demos Preview Files
AI PPTX generator with images AI PPTX generator preview created by OfficeCLI PPTX · Prompt · Metadata
Text-only AI PPTX generator Text-only AI PPTX generator preview created by OfficeCLI PPTX · Prompt · Metadata
DOCX generator CLI DOCX generator CLI preview created by OfficeCLI DOCX · Prompt · Metadata
XLSX automation dashboard XLSX automation preview created by OfficeCLI XLSX · Prompt · Metadata
Workbook-backed report generation Report generation preview created by OfficeCLI HTML report · Source XLSX · Prompt
Image generation CLI Image generation CLI preview created by OfficeCLI PNG · Prompt · Metadata

See demos/README.md for the complete reproducibility table and verification notes.

Optional AI agent integrations

AI agents can use OfficeCLI through public skills when you want the agent to route Office tasks into the local binary instead of calling the CLI manually. This is optional: the primary interface is still the officecli command.

Claude Code

OfficeCLI can be installed directly by Claude Code from the marketplace source.

OfficeCLI marketplace source:

/plugin marketplace add officecli/officecli

Install the primary plugin:

/plugin install officecli@officecli

Codex and other local agents

Use the direct installer when you want the public skill files without marketplace installation.

Use wget:

wget -qO- https://raw.githubusercontent.com/officecli/officecli/main/scripts/install-skill.sh | bash -s -- officecli

Or use curl:

curl -fsSL https://raw.githubusercontent.com/officecli/officecli/main/scripts/install-skill.sh | bash -s -- officecli

If you only want the skill and do not want to auto-install the binary:

curl -fsSL https://raw.githubusercontent.com/officecli/officecli/main/scripts/install-skill.sh | AUTO_INSTALL_BINARY=0 bash -s -- officecli

OpenClaw

If you want OpenClaw users to generate local Office files directly from Telegram, Discord, Slack, or other channels, install the OpenClaw-facing skill package.

Use wget:

wget -qO- https://raw.githubusercontent.com/officecli/officecli/main/scripts/install-openclaw-skill.sh | bash

Or use curl:

curl -fsSL https://raw.githubusercontent.com/officecli/officecli/main/scripts/install-openclaw-skill.sh | bash

The OpenClaw installer will:

  • install openclaw-officecli into ~/.openclaw/skills
  • create config.yaml from config.example.yaml when needed
  • try to auto-install the officecli binary when it is missing

If you only want the OpenClaw skill and do not want to auto-install the binary:

curl -fsSL https://raw.githubusercontent.com/officecli/officecli/main/scripts/install-openclaw-skill.sh | AUTO_INSTALL_BINARY=0 bash

Requirements

  • a local officecli binary
  • OfficeCLI access through hosted trial, hosted key, or External Mode configuration
  • optional publishing configuration when you want online preview URLs
  • for agent integrations, permission for the agent client to invoke local commands on the same machine

Quick verification after installation:

officecli --version
officecli config status

For OpenClaw, also verify:

officecli agent-bridge

OfficeCLI and officecli fit together

  • officecli is the command-line binary you use to generate Office files and images
  • this repository is the public install, docs, demos, and integration surface for that binary
  • officecli is also the general optional skill for Claude Code, Codex, and other local agents
  • openclaw-officecli is the OpenClaw-oriented package

FAQ

Is this repository a hosted SaaS plugin backend?

No. This repository distributes binary install docs, demos, scripts, and optional local skill wrappers.

Does the CLI require an AI agent?

No. The main workflow is direct CLI usage through commands like officecli new pptx, officecli new docx, officecli new xlsx, officecli new report, and officecli new img.

Can AI agents create PPTX, DOCX, XLSX, report, or img outputs with this repository?

Yes, when the local officecli runtime is installed and configured. The repository tells the agent how to route supported Office and image tasks into the local OfficeCLI binary.

Why does this repository mention Codex as well as Claude Code?

Because marketplace install is only one entrypoint. This repository also distributes direct skill files for Codex-style local agents and other agent runtimes.

Does this repository contain the full OfficeCLI implementation?

No. It contains public install docs, demos, scripts, skill definitions, and plugin wrappers.

Layout

  • install/README.md: install entrypoint for search and onboarding
  • claude-code/README.md: Claude Code marketplace install guide
  • codex/README.md: direct local install guide for Codex-style agents
  • openclaw/README.md: OpenClaw installer and bridge guide
  • faq/README.md: FAQ entrypoint
  • .claude-plugin/marketplace.json: Claude Code marketplace definition
  • demos/: reproducible demo gallery with preview images, prompts, metadata, and generated files
  • plugins/officecli/: Claude Code plugin wrapper for the officecli skill
  • plugins/openclaw-officecli/: Claude Code plugin wrapper for the openclaw-officecli skill
  • skills/officecli/: public OfficeCLI skill definition
  • skills/openclaw-officecli/: public OpenClaw skill definition
  • scripts/install-skill.sh: shell installer for direct wget / curl usage
  • scripts/install-openclaw-skill.sh: shell installer for OpenClaw users

About

OfficeCLI is AI document generation CLI for PPTX, DOCX, XLSX, Reports, and Images. Generate editable Office files from prompts with npm install, hosted trial, and optional agent skills.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages