https://github.com/officecli/officecli-npm
https://github.com/officecli/officecli-npm
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/officecli/officecli-npm
- Owner: officecli
- Created: 2026-04-14T08:38:42.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-23T07:56:48.000Z (21 days ago)
- Last Synced: 2026-05-23T09:28:40.509Z (21 days ago)
- Language: JavaScript
- Size: 37.1 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# officecli
[Website](https://officecli.io/) · [Discord](https://discord.gg/ezAHMkdG) · [X](https://x.com/officecli) · [GitHub](https://github.com/officecli/officecli)
`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:
```bash
brew uninstall officecli/homebrew-officecli/officecli
# If your Homebrew install uses the short formula name:
brew uninstall officecli
```
Then install through npm:
```bash
npm install -g officecli
```
Run it after install:
```bash
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:
```bash
officecli auth status
```
When the free quota is used up, run `officecli login`, then purchase hosted credits from https://officecli.io/pricing. Login prints a browser URL and short code, so it works even when the CLI cannot open a browser automatically. For scripts and CI, use `officecli set-key ` with an account API key.
To use your own model endpoint instead, switch to External Mode:
```bash
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 `x64`
- Windows `arm64`
## 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:
```bash
cd packages/npm/officecli
npm pack --dry-run
npm install
npm run smoke:version
```