drydock-cli 3.1.2__tar.gz → 3.1.4__tar.gz

{drydock_cli-3.1.2/drydock_cli.egg-info → drydock_cli-3.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: drydock-cli
-Version: 3.1.2
+Version: 3.1.4
 Summary: Drydock — a local, provider-agnostic terminal coding agent for local LLMs
 Author: Frank Bobe III
 License-Expression: Apache-2.0
@@ -267,6 +267,59 @@ exports the open findings to a deterministic **eMASS POA&M CSV** — Control (fr
 the CCI map), Vulnerability Description, `POA&M Status=Ongoing`, Milestone (the
 Fix Text), and Severity (CAT I/II/III → High/Moderate/Low) — no LLM, stdlib only.
 
+### Document Canvas — editing documents far larger than the context window
+
+Edit a 300-, 800-, 1000-page document the way you edit a large codebase: **search,
+open a small region, apply a hash-guarded patch, validate, commit** — the model
+never loads the whole document into context. Drydock parses the source into
+addressable **blocks** with stable ids (`sec-0004`, `para-0182`, …) and content
+hashes, and gives the model these tools:
+
+| Tool | What it does |
+|---|---|
+| `DocOpen` | Parse a document into the canvas and show its outline |
+| `DocOutline` / `DocSearch` / `DocRead` | Navigate + read small windows (never the whole file) |
+| `DocReplace` | Global search-and-replace across the whole document in one pass |
+| `DocPatch` | Hash-guarded, transactional edit of a block (replace / insert / delete) |
+| `DocRedact` | Permanently remove text and **verify** it can't be recovered ("red boxing") |
+| `DocDiff` / `DocValidate` | Preview staged changes; run structural + phrase checks |
+| `DocCommit` / `DocRollback` | Write the source (original kept as `<file>.orig`) or discard |
+
+**You don't call these tools yourself — you describe the task in plain English** and
+the model drives them (just like Read/Edit/Bash). It picks the canvas over
+`Read`/`Edit` automatically for documents too big to hold in context. For example,
+type into the TUI:
+
+```
+Open report.md and change every "single-factor authentication" to
+"phishing-resistant MFA", then validate and commit.
+
+Find the definition of "serendipity" in dictionary.pdf.
+
+Redact every SSN and phone number in disclosure.md, then commit a release copy.
+```
+
+Or run the bundled skill: `/document-canvas report.md redact all phone numbers`.
+
+Prefer to drive it yourself? The **`/doc`** slash command runs the canvas deterministically
+(no model), which is also the way to use it in the TUI regardless of what the model picks:
+
+```
+/doc open report.md
+/doc search report.md single-factor
+/doc replace report.md single-factor authentication :: phishing-resistant MFA
+/doc redact report.md SECRET-CODE-4471
+/doc diff report.md      # preview   ·   /doc validate report.md
+/doc commit report.md    # write (keeps report.md.orig)
+```
+
+**Formats:** `.md` / `.markdown` / `.txt` are edited in place. `.pdf` / `.docx` are
+imported read-only (text extracted; edits written to a `<file>.canvas.md` sidecar so
+the binary original is never overwritten). Every edit is **staged** in a working copy
+and hash-guarded, so the model can never clobber stale content; `DocCommit` writes the
+file and preserves the untouched original as `<file>.orig`. Redaction is the one
+**blocking** check — it refuses if the removed text would still be recoverable.
+
 ## Install
 
 ```bash

{drydock_cli-3.1.2 → drydock_cli-3.1.4}/README.md

@@ -243,6 +243,59 @@ exports the open findings to a deterministic **eMASS POA&M CSV** — Control (fr
 the CCI map), Vulnerability Description, `POA&M Status=Ongoing`, Milestone (the
 Fix Text), and Severity (CAT I/II/III → High/Moderate/Low) — no LLM, stdlib only.
 
+### Document Canvas — editing documents far larger than the context window
+
+Edit a 300-, 800-, 1000-page document the way you edit a large codebase: **search,
+open a small region, apply a hash-guarded patch, validate, commit** — the model
+never loads the whole document into context. Drydock parses the source into
+addressable **blocks** with stable ids (`sec-0004`, `para-0182`, …) and content
+hashes, and gives the model these tools:
+
+| Tool | What it does |
+|---|---|
+| `DocOpen` | Parse a document into the canvas and show its outline |
+| `DocOutline` / `DocSearch` / `DocRead` | Navigate + read small windows (never the whole file) |
+| `DocReplace` | Global search-and-replace across the whole document in one pass |
+| `DocPatch` | Hash-guarded, transactional edit of a block (replace / insert / delete) |
+| `DocRedact` | Permanently remove text and **verify** it can't be recovered ("red boxing") |
+| `DocDiff` / `DocValidate` | Preview staged changes; run structural + phrase checks |
+| `DocCommit` / `DocRollback` | Write the source (original kept as `<file>.orig`) or discard |
+
+**You don't call these tools yourself — you describe the task in plain English** and
+the model drives them (just like Read/Edit/Bash). It picks the canvas over
+`Read`/`Edit` automatically for documents too big to hold in context. For example,
+type into the TUI:
+
+```
+Open report.md and change every "single-factor authentication" to
+"phishing-resistant MFA", then validate and commit.
+
+Find the definition of "serendipity" in dictionary.pdf.
+
+Redact every SSN and phone number in disclosure.md, then commit a release copy.
+```
+
+Or run the bundled skill: `/document-canvas report.md redact all phone numbers`.
+
+Prefer to drive it yourself? The **`/doc`** slash command runs the canvas deterministically
+(no model), which is also the way to use it in the TUI regardless of what the model picks:
+
+```
+/doc open report.md
+/doc search report.md single-factor
+/doc replace report.md single-factor authentication :: phishing-resistant MFA
+/doc redact report.md SECRET-CODE-4471
+/doc diff report.md      # preview   ·   /doc validate report.md
+/doc commit report.md    # write (keeps report.md.orig)
+```
+
+**Formats:** `.md` / `.markdown` / `.txt` are edited in place. `.pdf` / `.docx` are
+imported read-only (text extracted; edits written to a `<file>.canvas.md` sidecar so
+the binary original is never overwritten). Every edit is **staged** in a working copy
+and hash-guarded, so the model can never clobber stale content; `DocCommit` writes the
+file and preserves the untouched original as `<file>.orig`. Redaction is the one
+**blocking** check — it refuses if the removed text would still be recoverable.
+
 ## Install
 
 ```bash

drydock_cli-3.1.4/drydock/builtin_skills/document-canvas.md

@@ -0,0 +1,40 @@
+---
+name: document-canvas
+description: Edit a large document (md/txt) via the Document Canvas — search, patch, validate, commit, without loading it all
+---
+Edit the document as a CANVAS — never load the whole thing into context. Target
+for this task: $ARGS
+
+Work like a programmer editing a large codebase. Address blocks by their stable
+id (para-0182, sec-0004, …), not by line numbers or page numbers.
+
+1. **Open.** Call DocOpen with the file path. Read the outline it returns to
+   understand the structure. (The document name is the filename.)
+
+2. **Locate — don't read everything.** Use DocSearch to find the blocks relevant
+   to the change (exact text, or regex:true for patterns like requirement numbers).
+   Use DocOutline to navigate the hierarchy. Only the blocks you open enter context.
+
+3. **Read the target region.** Call DocRead on each candidate block with a small
+   `before`/`after` window so you understand its context. Note each target's
+   content **hash** — you must pass it back as `expected_hash`.
+
+4. **Patch — hash-guarded, staged.** Call DocPatch with op (replace / insert_before
+   / insert_after / delete), target_id, the `expected_hash` from DocRead, and
+   new_text plus a short `reason`. Patches are STAGED in a working copy — the source
+   file is NOT changed yet. If a hash is stale the patch is rejected; re-DocRead and
+   retry. For several related edits, pass a `patches` list so they apply atomically.
+
+5. **Preview.** Call DocDiff to see every staged change as a unified diff. Confirm
+   you changed only what you intended and did not over-edit neighbouring text.
+
+6. **Validate.** Call DocValidate (pass `prohibited` for terms that must be gone and
+   `required` for terms that must remain). Resolve any ⚠ findings before committing.
+
+7. **Commit.** Only when the diff and validation look right, call DocCommit. It
+   writes the source file and preserves the untouched original as <file>.orig. Use
+   DocRollback to discard staged edits instead.
+
+For a global change (e.g. a terminology update), search for ALL occurrences, then
+process them in small batches — you do not need every passage in context at once.
+Report which blocks you changed and the final validation result.