Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (officecli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

officecli

Official website: https://officecli.io/

officecli is an npm wrapper package for the OfficeCLI binary.

It does not reimplement the CLI in JavaScript. During npm install, it downloads the matching prebuilt binary from officecli/officecli-dist, verifies checksums.txt, and exposes the officecli command on your PATH.

Install

Install OfficeCLI through one channel only. If you previously installed OfficeCLI with Homebrew, keep using Homebrew and do not install the npm wrapper on top of it. To intentionally switch from Homebrew to npm, uninstall the Homebrew formula first:

brew uninstall officecli/homebrew-officecli/officecli
# If your Homebrew install uses the short formula name:
brew uninstall officecli

Then install through npm:

npm install -g officecli

Run it after install:

officecli --version
officecli
officecli --no-alt-screen
officecli "Create a Q3 business review deck"

The default command opens a persistent Codex-style TUI with the latest conversation and generation progress near the bottom input box. Use --no-alt-screen to keep terminal scrollback visible.

For scripts and automation, use officecli new ....

The installed binary is usable without a local model endpoint or an API key. By default it uses OfficeCLI hosted anonymous trial access on https://platform.officecli.io; the one-time free quota is tied to this machine.

Check access at any time:

officecli auth status

When the free quota is used up, run officecli auth set-key <api-key> after purchasing or creating a hosted key from https://officecli.io/pricing.

To use your own model endpoint instead, switch to External Mode:

officecli config set-runtime external
officecli config set-generation

Version Mapping

npm package version 0.2.57 downloads OfficeCLI release v0.2.57
the wrapper installs only the current stable binary that matches the package version

Supported Platforms

macOS x64
macOS arm64
Linux x64
Linux arm64

Windows is not supported yet because the current public binary release flow only publishes darwin and linux archives.

Environment Overrides

OFFICECLI_NPM_DIST_REPO: override the GitHub release repository, default officecli/officecli-dist
OFFICECLI_NPM_SKIP_DOWNLOAD=1: skip the postinstall download step

Legacy environment variables OFFICECLI_NPM_VERSION and OFFICECLI_NPM_LATEST_TAG are no longer supported because public distribution now keeps only the current stable release.

Local Validation

From this repository:

cd packages/npm/officecli
npm pack --dry-run
npm install
npm run smoke:version