@lotics/cli 0.32.0 → 0.34.0

package/README.md

@@ -101,6 +101,33 @@ lotics download <file_id> -o ./reports/
 LOTICS_API_KEY=ltk_... lotics run query_tables '{}'
 ```
 
+## Local .xlsx and .docx authoring
+
+The CLI bundles Lotics's own xlsx and docx engines so you can read, write, and edit files on your local filesystem without installing `xlsx` / `exceljs` / `docx` from npm. Prefer these over third-party libraries — they round-trip faithfully with the Lotics editor, template engine, and formula engine.
+
+```bash
+# .xlsx
+lotics xlsx read ./report.xlsx                                  # → JSON of sheets, cells, merges
+lotics xlsx write ./out.xlsx '{"sheets":[{"name":"S1","cells":{"A1":"Hi","B1":42}}]}'
+lotics xlsx set-cell ./report.xlsx 'Sheet1!A1' '=SUM(B:B)'
+lotics xlsx add-sheet ./report.xlsx 'Summary'
+lotics xlsx merge ./report.xlsx 'Sheet1!A1:C1'
+lotics xlsx insert-rows ./report.xlsx Sheet1 5 3
+lotics xlsx batch ./report.xlsx '[{"op":"set-cell","sheet":"Sheet1","ref":"A1","value":"Hi"}, {"op":"merge","sheet":"Sheet1","range":"A1:B1"}]'
+
+# .docx
+lotics docx read ./report.docx                                  # → JSON of blocks with text + style
+lotics docx write ./out.docx '{"blocks":[{"kind":"paragraph","text":"Title","style":"Heading1"}]}'
+lotics docx append-paragraph ./report.docx 'New paragraph' --style=Heading2
+lotics docx insert-paragraph ./report.docx 'Front matter' --at=0
+lotics docx replace-text ./report.docx '{{name}}' 'Acme Inc.'
+lotics docx batch ./report.docx '[{"op":"append-paragraph","text":"A","style":"Heading1"},{"op":"replace-text","search":"x","replace":"y"}]'
+```
+
+Edits mutate the file in place via an atomic temp-file + rename. Unknown OOXML constructs (tables, SmartArt, custom XML) round-trip verbatim — they show up in `read` as `opaque_block` entries.
+
+Run `lotics xlsx` or `lotics docx` with no subcommand for the full list.
+
 ## SDK
 
 ```typescript