Skip to content

Commit 8098424

Browse files
authored
Merge pull request #12 from AuntXue/docs/runtime-positioning
docs: align README with DeckFlow Runtime positioning
2 parents 8511114 + 9007116 commit 8098424

1 file changed

Lines changed: 31 additions & 4 deletions

File tree

README.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,27 @@
22

33
# DeckProbe
44

5-
**`ffprobe` for PDF, Microsoft Office, and Apple iWork documents.**
5+
**`ffprobe` for documents, built for agents.**
66

77
Ask for the facts you need. Get structured JSON with confidence, evidence, and measured I/O cost.
88

99
[![CI](https://github.com/deckflow/deckprobe/actions/workflows/ci.yml/badge.svg)](https://github.com/deckflow/deckprobe/actions/workflows/ci.yml)
1010
[![License: MIT](https://img.shields.io/badge/license-MIT-2f80ed.svg)](LICENSE)
1111
[![Rust 1.88+](https://img.shields.io/badge/rust-1.88%2B-orange.svg)](https://www.rust-lang.org/)
1212

13-
[Install](docs/INSTALLATION.md) · [Quickstart](#quickstart) · [Agent skill](#use-from-a-coding-agent) · [npm package](#javascript-package) · [Execution modes](#execution-modes) · [Examples](#common-recipes) · [Formats](#supported-formats) · [CLI reference](docs/CLI-REFERENCE.md)
13+
[Install](docs/INSTALLATION.md) · [Quickstart](#quickstart) · [Runtime role](#where-deckprobe-fits) · [Agent skill](#use-from-a-coding-agent) · [npm package](#javascript-package) · [Execution modes](#execution-modes) · [Examples](#common-recipes) · [Formats](#supported-formats) · [CLI reference](docs/CLI-REFERENCE.md)
1414

1515
</div>
1616

17-
DeckProbe is a goal-oriented Rust engine, native CLI, and browser SDK for examining untrusted PDF, Microsoft Office, and modern Apple iWork documents—without rendering them or launching a desktop office suite. Rather than unpacking everything upfront, it selects the most efficient probe path that meets your requested targets and confidence level.
17+
DeckProbe is the probing engine of the DeckFlow Runtime. It performs low-cost
18+
preflight inspection and returns structured evidence that callers can use before
19+
more expensive parsing, OCR, rendering, uploading, or model ingestion.
20+
21+
Available as a target-driven Rust engine, native CLI, and browser SDK, DeckProbe
22+
inspects untrusted PDF, Microsoft Office, and modern Apple iWork documents
23+
without rendering them or starting a desktop office suite. Instead of eagerly
24+
unpacking everything, it chooses the cheapest probe path that can satisfy the
25+
targets and confidence you requested.
1826

1927
```console
2028
$ deckprobe --pretty -t slide_count deck.pptx
@@ -35,6 +43,25 @@ $ deckprobe --pretty -t slide_count deck.pptx
3543
User-facing examples use short target names; reports retain stable canonical
3644
keys for machine consumers.
3745

46+
## Where DeckProbe fits
47+
48+
DeckFlow is the Document Runtime for Agents. Its product model has three engine
49+
responsibilities:
50+
51+
| Engine | Responsibility |
52+
|---|---|
53+
| Probe / DeckProbe | Inspect and expose bounded preflight signals for routing decisions. |
54+
| Parse / DeckParse | Make document content and structure operable as persistent state. |
55+
| Render / DeckRender | Produce visual representations for humans, AI, and software. |
56+
57+
DeckProbe can run independently. In a larger Runtime workflow, its report helps
58+
the calling agent or application decide whether to parse, render, reject, or use
59+
another path. DeckProbe provides the evidence for that decision; it does not
60+
automatically choose or execute downstream actions.
61+
62+
DeckProbe is not a general-purpose parser, renderer, OCR engine, editor, or
63+
complete security product.
64+
3865
## Why DeckProbe
3966

4067
| Need | What DeckProbe does |
@@ -491,7 +518,7 @@ man ./deckprobe.1
491518

492519
## Current limitations
493520

494-
DeckProbe 2.2 intentionally does not render files, run OCR, execute macros,
521+
DeckProbe intentionally does not render files, run OCR, execute macros,
495522
follow external links, or send documents to a remote service.
496523

497524
- PDF metadata currently reads the Info dictionary; XMP merging is not implemented.

0 commit comments

Comments
 (0)