DeckFlow Logo Developers DeckFlow documentation
Developer GuideAPI ReferenceMCPCLI

CLI Commands

DeckUse commands operate on local PPTX workspaces. DeckOps commands operate on DeckFlow backend tasks.

DeckUse Commands

DeckUse command pattern:

deckuse <command> [options]
CommandPurpose
deckuse init <pptx> [--dir <dir>]Unpack a PPTX into a local DeckUse workspace.
deckuse status <workspace>Show workspace status.
deckuse commit <workspace> [-o <pptx>]Build the workspace back into a PPTX.
deckuse list slides <workspace>List slides and inferred structure.
deckuse show slide <workspace> <slide>Show details for one slide.
deckuse get text <workspace> <selector>Read text from a selector.
deckuse set text <workspace> <selector> <text> [-o <pptx>]Replace text at a selector.
deckuse set font-size <workspace> <selector> <size> [-o <pptx>]Set font size in points.
deckuse move <workspace> <selector> --left <n> --top <n> [-o <pptx>]Move matched shapes by left/top percentage.
deckuse replace <workspace> <search> <replace> [--slide <n>] [--regex] [-o <pptx>]Replace text globally or on one slide.

DeckUse selectors address slide and shape structure:

deckuse get text ./company.deck "slide:3/title"
deckuse get text ./company.deck "slide:1/shape[id=6]/shape[id=9]"
deckuse get text ./company.deck "slide:1/#6,9"
deckuse set text ./company.deck "shape[type=textbox]" "Updated"

Write behavior:

  • When <workspace> is a workspace directory, write commands modify the workspace; -o/--output is optional and exports a PPTX if provided.
  • When <workspace> is a .pptx file path, write commands require -o/--output because the CLI needs an explicit output file.
  • DeckUse does not render slides. Use DeckOps for rendering and format conversion.

DeckOps Commands

DeckOps command pattern:

deckops [--json] <command> [options]

Use --json for machine-readable output in scripts and agents.

Login and Config

deckops login [--port <port>]
deckops config set-token <token>
deckops config set-space <space-id>
deckops config set-api-base <url>
deckops config show

Default callback port is 3737. Config is stored at ~/.deckops/config.json.

Task Management

deckops task list [--type <type>] [--limit <n>] [--offset <n>]
deckops task get <task-id>
deckops task delete <task-id>

Compress

deckops compress <input-file> [--no-wait] [--timeout <seconds>]

Supported inputs include .zip, .pptx, .key, .docx, .xlsx, .mp4, .avi, .mov, and .mkv.

OCR

deckops ocr <input-file> [--language <lang>] [--no-wait] [--timeout <seconds>]

Supported inputs are .jpg, .jpeg, and .png. Default language is zh-hans; supported languages include zh-hans, zh-hant, en, ja, ko, ar, de, es, fr, it, pt, and ru.

Extract

deckops extract <input-file> [--type <fonts|text-shapes>] [--no-wait] [--timeout <seconds>]

Current documented extraction types map to pptx.getFontInfo and pptx.getTextShapes.

Convert

deckops convert <input-files...> --to <format> \
  [--width <number>] [--height <number>] \
  [--need-embed-fonts [boolean]] \
  [--no-wait] [--timeout <seconds>]

Supported output formats are image, pdf, video, html, png, pptx, and webp.

Important conversion notes:

  • PPT/PPTX/PDF/KEY can render to images depending on source format.
  • PPT/PPTX/DOC/DOCX/KEY can convert to PDF depending on source format.
  • PPT/PPTX can convert to video.
  • KEY can convert to HTML.
  • HTML/Markdown can convert to PNG.
  • PPT/HTML can convert to PPTX.
  • JPG/JPEG/PNG can convert to WebP.
  • Multiple input files are currently supported only for HTML to PPTX conversion.
  • --width, --height, and --need-embed-fonts are relevant to HTML conversion paths.

Create

deckops create [input-files...] \
  [--input-text <text>] \
  [--enable-search [boolean]] \
  [--advanced-model [boolean]] \
  [--fast-mode [boolean]] \
  [--intent <intent>] \
  [--audience <audience>] \
  [--page-count <number>] \
  [--author <name>] \
  [--no-wait] [--timeout <seconds>]

At least one of --input-text or input files is required. Up to two reference files are allowed. Supported reference extensions are .html, .pdf, .docx, .pptx, .txt, .md, .mm, .xmind, and .ipynb.

Translate

deckops translate <input-file> \
  --from <language> \
  --to <language> \
  --model <Standard|Pro> \
  [--use-glossary [boolean]] \
  [--image-translate [boolean]] \
  [--no-wait] [--timeout <seconds>]

Supported inputs are .docx, .pptx, .pdf, .xlsx, and .key. Source language supports auto plus common language codes; target language requires an explicit supported language code.

Join

deckops join <input-files...> [--name <name>] [--no-wait] [--timeout <seconds>]

Requires at least two .pptx files. Files are merged in command-line order.

Run Explicit Task Type

deckops run <task-type> <input-files...> \
  [--param <key=value>] \
  [--no-wait] [--timeout <seconds>]

--param can be repeated. Values are parsed as JSON when possible.

REPL

deckops repl

Use the REPL for repeated interactive operations against the same DeckOps configuration.

Source Basis