DeckFlow Logo Developers DeckFlow documentation
Get Started
Developer GuideAPI ReferenceMCPCLI

CLI Install

Install DeckUse for local PPTX edits, install DeckOps for cloud-backed DeckFlow tasks. Both packages require Node.js 18 or newer.

DeckUse

DeckUse is the local-first CLI. It is used for PPTX structural operations that run on local files and local workspaces.

npm install -g deckuse
deckuse --help

GitHub currently shows npm install -g @deckflow/deckuse in the README, but the public npm registry checked on 2026-05-27 exposes the package as deckuse; the scoped package @deckflow/deckuse was not available in the public registry at that time.

Install from source if you want to run the GitHub repo directly:

git clone https://github.com/deckflow/deckuse.git
cd deckuse
pnpm install
pnpm build
pnpm link --global
deckuse --help

DeckUse does not require login, API key, space ID, or a backend URL for its core workflow. The normal flow is:

deckuse init company.pptx --dir ./company.deck
deckuse list slides ./company.deck
deckuse replace ./company.deck "2025" "2026"
deckuse commit ./company.deck --output company-2026.pptx

DeckOps

DeckOps is the cloud-backed task CLI. It uploads files to the DeckFlow backend, creates tasks, optionally waits for completion, and stores authentication locally.

npm install -g deckops
deckops --help

Install from source if you want to run the GitHub repo directly:

git clone https://github.com/deckflow/deckops.git
cd deckops
npm install
npm run build
node dist/cli.js --help

Authenticate with the browser login flow:

deckops login

The login command opens a browser and receives the callback on http://localhost:3737 by default. Credentials are stored in:

~/.deckops/config.json

Common configuration fields:

{
  "token": "your-auth-token",
  "spaceId": "your-space-id",
  "apiBase": "https://app.deckflow.com/v1"
}

You can also configure DeckOps manually:

deckops config set-token <token>
deckops config set-space <space-id>
deckops config set-api-base https://app.deckflow.com/v1
deckops config show

DeckOps requires network access and valid credentials for most commands. If credentials are missing, API commands can trigger the login flow. If the backend returns 401, DeckOps attempts re-login and retry. If the backend returns 402, it opens checkout flow before continuing.

Install Decision

Install only deckuse when you need local, offline-friendly PPTX edits and do not want files sent to a cloud service.

Install deckops when you need DeckFlow backend capabilities such as generation, translation, rendering, OCR, compression, file conversion, or long-running task management.

Many workflows use both: DeckUse for local structural cleanup, then DeckOps for cloud rendering or translation.

Source Basis