@bendyline/docblocks-cli 2.0.0 → 2.1.1

package/README.md

@@ -4,6 +4,8 @@ The DocBlocks command-line surface for document build and preview, linked-Squisq
 format conversion, MP4 rendering, document parsing, and a local MCP server for
 agents.
 
+[CLI and MCP overview](https://docblocks.com/cli/)
+
 ## Installation
 
 Node.js 22.14 or newer is required.
@@ -25,7 +27,6 @@ directions, overwrite behavior, MCP authority, artifact lifecycle, and assurance
 
 | Command                            | Purpose                                               |
 | ---------------------------------- | ----------------------------------------------------- |
-| `docblocks init [dir]`             | Create minimal `.docblocks/config.json` metadata.     |
 | `docblocks build`                  | Recursively build Markdown into standalone HTML.      |
 | `docblocks serve`                  | Run a constrained local preview server.               |
 | `docblocks convert <input>`        | Convert through the linked Squisq registry.           |
@@ -65,11 +66,18 @@ docblocks mcp --allow-read ./documents --allow-write ./exports
 ```
 
 `convert` and `video` accept Markdown, Squisq JSON Doc, DBK/ZIP, folders, and
-import-capable linked-registry formats. Direct `build`, `convert`, and `video`
-outputs replace existing destination files. MCP conversions instead return
+import-capable linked-registry formats. `build` replaces generated HTML files;
+`convert` and `video` refuse existing destinations unless `--allow-overwrite` is
+passed. Multi-target conversion stages the complete batch and rolls back replacements
+if publication fails. Build traversal, input bytes, and output bytes are bounded, as
+are parse input and JSON output. MCP conversions instead return
 immutable session artifacts; only explicit `save_artifact` materializes one, using
 no-replace or hash-conditional replacement semantics.
 
+The package root is a side-effect-free programmatic API for `runBuild`, `runConvert`,
+`runVideo`, and `runParse`. Importing it never starts Commander; the executable is
+the separate `docblocks` bin entry.
+
 The live linked registry currently covers Markdown, DOCX, PDF, PPTX, XLSX, CSV,
 HTML, HTML ZIP, EPUB, DBK, MP4, and GIF. Direction varies by format, so use the
 CLI reference or MCP `list_formats` rather than assuming every format imports.
@@ -77,17 +85,3 @@ CLI reference or MCP `list_formats` rather than assuming every format imports.
 MP4/GIF rendering requires Chromium and FFmpeg. Install Chromium with
 `npx playwright install chromium`; Squisq resolves FFmpeg from `SQUISQ_FFMPEG`,
 `PATH`, or `ffmpeg-static`, in that order.
-
-## Development with linked Squisq
-
-From the DocBlocks repository root:
-
-```bash
-npm run link:squisq
-npm run check:squisq-linked
-npm run test:mcp:linked
-npm run all
-```
-
-The linked assurance commands use the sibling `..\squisq` source checkout, not the
-npm package copy.

package/dist/bin.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node