DeckFlow Logo Developers DeckFlow documentation
Developer GuideAPI ReferenceMCPCLI

CLI Examples

Use DeckUse for local PPTX edits. Use DeckOps for cloud tasks that need DeckFlow backend processing.

DeckUse: Local PPTX Text Update

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

This workflow stays local after installation. No login, API key, backend task, or file upload is required.

DeckUse: Inspect and Edit One Slide

deckuse init roadmap.pptx --dir ./roadmap.deck
deckuse show slide ./roadmap.deck 3
deckuse get text ./roadmap.deck "slide:3/title"
deckuse set text ./roadmap.deck "slide:3/title" "2026 Product Roadmap"
deckuse set font-size ./roadmap.deck "slide:3/title" 28
deckuse commit ./roadmap.deck --output roadmap-updated.pptx

Use selector expressions such as slide:3/title, shape[type=textbox], or slide:1/#6,9 to target existing elements.

DeckUse: Direct PPTX Input With Explicit Output

deckuse replace deck.pptx "OldBrand" "NewBrand" --output deck-brand-updated.pptx
deckuse set text deck.pptx "slide:1/title" "New Launch Plan" --output deck-title-updated.pptx

When editing a raw .pptx path instead of an initialized workspace, pass --output so the modified deck has an explicit destination.

DeckOps: Login and Check Tasks

deckops login
deckops task list --limit 10

DeckOps stores credentials in ~/.deckops/config.json and calls the DeckFlow backend for task operations.

DeckOps: Generate a Deck

deckops create \
  --input-text "Please write an API design document for developers" \
  --audience "Engineering Team" \
  --page-count 6

Use reference files when the deck should be grounded in existing material:

deckops create refs.md refs.pdf \
  --input-text "Generate a summary based on the reference materials" \
  --audience "Management" \
  --page-count 8

DeckOps allows up to two reference files for create.

DeckOps: Translate a Document

deckops translate handbook.docx \
  --from zh \
  --to en \
  --model Standard
deckops translate slides.pdf \
  --from ja \
  --to zh-hans \
  --model Pro \
  --image-translate true

Translation is a cloud task, so the command requires a valid DeckOps token/space and network access.

DeckOps: Convert and Render

deckops convert slides.pptx --to pdf
deckops convert slides.pptx --to video --timeout 900
deckops convert page.html --to pptx --width 1920 --height 1080 --need-embed-fonts true

Use --no-wait when a task should start in the background:

deckops convert slides.pptx --to pdf --no-wait --json
deckops task get <task-id> --json

DeckOps: Compress, OCR, and Join

deckops compress presentation.pptx
deckops ocr screenshot.png --language en
deckops join cover.pptx chapter-1.pptx appendix.pptx --name combined-deck

Combined Workflow

Use DeckUse first when edits are deterministic and local, then DeckOps when the result needs a cloud operation:

deckuse init source.pptx --dir ./source.deck
deckuse replace ./source.deck "2025" "2026"
deckuse commit ./source.deck --output source-clean.pptx

deckops convert source-clean.pptx --to pdf
deckops translate source-clean.pptx --from zh --to en --model Standard

This split keeps simple structural edits local while reserving cloud requests for rendering, translation, OCR, generation, and other backend tasks.

Source Basis