@superdoc-dev/cli 0.3.0-next.10 → 0.3.0-next.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superdoc-dev/cli",
-  "version": "0.3.0-next.10",
+  "version": "0.3.0-next.13",
   "type": "module",
   "bin": {
     "superdoc": "./dist/index.js"
@@ -20,21 +20,21 @@
     "@types/bun": "^1.3.8",
     "@types/node": "22.19.2",
     "typescript": "^5.9.2",
-    "@superdoc/pm-adapter": "0.0.0",
     "@superdoc/super-editor": "0.0.1",
-    "superdoc": "1.19.0",
-    "@superdoc/document-api": "0.0.1"
+    "@superdoc/pm-adapter": "0.0.0",
+    "@superdoc/document-api": "0.0.1",
+    "superdoc": "1.19.0"
   },
   "module": "src/index.ts",
   "publishConfig": {
     "access": "public"
   },
   "optionalDependencies": {
-    "@superdoc-dev/cli-darwin-arm64": "0.3.0-next.10",
-    "@superdoc-dev/cli-linux-x64": "0.3.0-next.10",
-    "@superdoc-dev/cli-linux-arm64": "0.3.0-next.10",
-    "@superdoc-dev/cli-windows-x64": "0.3.0-next.10",
-    "@superdoc-dev/cli-darwin-x64": "0.3.0-next.10"
+    "@superdoc-dev/cli-darwin-arm64": "0.3.0-next.13",
+    "@superdoc-dev/cli-darwin-x64": "0.3.0-next.13",
+    "@superdoc-dev/cli-linux-x64": "0.3.0-next.13",
+    "@superdoc-dev/cli-linux-arm64": "0.3.0-next.13",
+    "@superdoc-dev/cli-windows-x64": "0.3.0-next.13"
   },
   "scripts": {
     "dev": "bun run src/index.ts",

package/skill/SKILL.md

@@ -5,7 +5,7 @@ description: Edit, query, and transform Word documents with the SuperDoc CLI v1
 
 # SuperDoc CLI (v1)
 
-Use SuperDoc CLI for DOCX work. Prefer canonical v1 commands.
+Use SuperDoc CLI for DOCX work. Use v1 commands (canonical operations and their helper wrappers).
 Do not default to legacy commands unless explicitly needed for v0-style bulk workflows.
 
 Use `superdoc` if installed, or `npx @superdoc-dev/cli@latest` as a fallback.
@@ -28,12 +28,13 @@ Use `describe command` for per-command args and constraints.
 
 ```bash
 superdoc open ./contract.docx
-superdoc find --type text --pattern "termination"
+superdoc query match --select-json '{"type":"text","pattern":"termination"}' --require exactlyOne
 superdoc replace --target-json '{"kind":"text","blockId":"p1","range":{"start":0,"end":11}}' --text "expiration"
 superdoc save --in-place
 superdoc close
 ```
 
+- Always use `query match` (not `find`) to discover mutation targets — it returns exact addresses with cardinality guarantees.
 - After `open`, commands run against the active/default session when `<doc>` is omitted.
 - Use `superdoc session list|set-default|save|close` for explicit session control.
 - `close` on dirty state requires `--discard` or a prior `save`.
@@ -57,28 +58,80 @@ superdoc replace ./proposal.docx \
 
 - In stateless mode (`<doc>` provided), mutating commands require `--out` unless using `--dry-run`.
 
+### Safety: preview before apply
+
+- Use `--dry-run` to preview any mutation without applying it.
+- Use `--expected-revision <n>` with stateful mutations for optimistic concurrency checks.
+
 ## Common v1 Commands
 
-- Search text/nodes: `find --type text --pattern "..."` or `find --query-json '{...}'`
-- Replace text: `replace --target-json '{...}' --text "..."`
-- Add/edit comments: `comments add|reply|edit|resolve|remove`
-- Review tracked changes: `track-changes list|accept|reject|accept-all|reject-all`
+### Query & inspect
+
+- Search/browse content: `find --type text --pattern "..."` or `find --query-json '{...}'`
+- Find mutation target: `query match --select-json '{...}' --require exactlyOne`
+- Inspect blocks: `blocks list`, `get-node`, `get-node-by-id`
 - Extract content: `get-text`, `get-markdown`, `get-html`
-- Low-level direct invoke: `call <operationId> --input-json '{...}'`
+
+### Mutate
+
+- Replace text: `replace --target-json '{...}' --text "..."`
+- Insert inline text: `insert --block-id <id> --offset <n> --value "..."`
+- Delete text/node: `delete --target-json '{...}'`
+- Delete blocks: `blocks delete`, `blocks delete-range`
+- Batch mutations: `mutations apply --steps-json '[...]' --atomic true --change-mode direct`
+- Create paragraph: `create paragraph --text "..."` (with optional `--at-json`)
+- Create heading: `create heading --input-json '{"level":<n>,"text":"..."}'`
+
+### Format
+
+- Apply formatting: `format apply --block-id <id> --start <n> --end <n> --inline-json '{"bold":true}'`
+- Shortcuts: `format bold`, `format italic`, `format underline`, `format strikethrough`
+
+### Lists
+
+- List items: `lists list`, `lists get`
+- Insert list item: `lists insert --node-id <id> --position after --text "..."`
+- Modify: `lists indent`, `lists outdent`, `lists set-level`, `lists set-type`, `lists convert-to-text`
+
+### Comments
+
+- Add/reply: `comments add`, `comments reply`
+- Read: `comments get`, `comments list`
+- Edit/resolve/move: `comments edit`, `comments resolve`, `comments move`, `comments set-internal`
+- Delete: `comments delete` (canonical) or `comments remove` (alias)
+
+### Track changes
+
+- List: `track-changes list`, `track-changes get`
+- Decide: `track-changes accept`, `track-changes reject`, `track-changes accept-all`, `track-changes reject-all`
+
+### History
+
+- `history get`, `history undo`, `history redo`
+
+### Low-level
+
+- Direct invoke: `call <operationId> --input-json '{...}'` (JSON output only — `--pretty` is not supported)
 
 ## JSON/File Payload Flags
 
-Use one of each pair (not both):
+Not all `--*-file` variants are available on every command. Use `describe command <name>` to check.
+
+Always supported alongside their `-json` counterpart (use one, not both):
+
+| Flag pair | Available on |
+|-----------|-------------|
+| `--query-json` / `--query-file` | `find`, `lists list` |
+| `--address-json` / `--address-file` | `get-node`, `lists get` |
+| `--input-json` / `--input-file` | `call`, `create paragraph` |
+| `--at-json` / `--at-file` | `create paragraph` |
 
-- `--query-json` or `--query-file`
-- `--target-json` or `--target-file`
-- `--address-json` or `--address-file`
-- `--input-json` or `--input-file` (for `call`)
+`--target-json` is widely available on mutation commands but has **no** `--target-file` counterpart. Use flat flags (`--block-id`, `--start`, `--end`) as an alternative to `--target-json`.
 
 ## Output and Global Flags
 
 - Default output is JSON envelope.
-- Use `--pretty` for human-readable output.
+- Use `--pretty` for human-readable output (not supported by `call`).
 - Global flags: `--output <json|pretty>`, `--session <id>`, `--timeout-ms <n>`.
 - `<doc>` can be `-` to read DOCX bytes from stdin.