Skip to content

docs: strengthen Deckuse automation value #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zhaoxiongfei merged 2 commits into from
Sep 17, 2026
+17 −0
Merged

docs: strengthen Deckuse automation value #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1aee510
docs: strengthen Deckuse automation value
AuntXue Aug 20, 2026
9e6e964
Merge branch 'main' into docs/automation-value
zhaoxiongfei Sep 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@

</div>

Deckuse is a local-first, schema-driven Office document automation engine for coding agents. It turns document editing into an explicit, reviewable workflow: open a versioned workspace, inspect and target its structure, apply JSON commands, validate the result, and export a new document.

The engine is built around format adapters. PPTX is the currently implemented format; DOCX, XLSX, Keynote, and Numbers adapters return `FORMAT_NOT_IMPLEMENTED` today, so agents fail clearly instead of silently producing unsafe edits.
Deckuse is a local-first, schema-driven Office document automation engine for coding agents. It opens a document into a versioned workspace, lets an agent inspect and target its structure with semantic addresses (`slide:1/shape:2`), applies explicit mutations, validates the result, and exports a new document.

This repository is the **community edition** (`edition=community`). See [docs/edition.md](docs/edition.md). Shared packages here are the source of truth; the commercial edition is a private thin overlay (`deckuse-commercial`) that swaps `@deckflow/deckuse-edition-config`, registers a `PptxEditionExtension` for gated writes, and may add proprietary packages.
Expand Down Expand Up @@ -39,6 +42,20 @@ Every successful write automatically commits a Git revision, updates `operations

It preserves untouched XML and unknown package parts where possible. It is not a full PowerPoint rendering or layout engine and cannot reliably judge whether a slide is visually attractive or whether a layout is visually correct. Use `monitor` for live HTML preview and `render` to screenshot one slide to PNG for agent visual review. Semantic `diff` / `branch` remain deferred past Phase 1a.

## Where it creates value

Deckuse is designed for document changes that need to be precise, repeatable,
and auditable:

- **Recurring content updates** — refresh dates, metrics, names, pricing, and
disclaimers without rebuilding a presentation.
- **Customer and market variants** — create controlled versions with explicit
selectors and reviewable operations.
- **Content governance** — query sensitive or outdated content, inspect every
match, and validate before export.
- **Agent-driven automation** — use structured JSON, revision checks, dry runs,
atomic batches, and operation logs in larger workflows.

## Installation

Requirements: Node.js 18 or later.
Expand Down