zinkee 0.1.23 → 0.1.24

package/AGENTS.md

@@ -36,6 +36,7 @@ Use this order when reasoning about behavior:
 - `teamspace`
 - `displays`
 - `automations`
+- `document-templates`
 
 ## Implementation Shape
 

package/README.md

@@ -17,6 +17,7 @@ Implemented command groups:
 - `teamspace`
 - `displays`
 - `automations`
+- `document-templates`
 
 ## Requirements
 
@@ -656,6 +657,58 @@ zinkee --json automations connections list
 
 ---
 
+## Document templates
+
+Document templates group reusable files (e.g. Word/Excel masters) that automations can render against a record via the `generate_document` action. Names must be unique within the workspace; the `<template>` argument accepts a UUID or an exact name. The `<asset>` argument requires a UUID.
+
+### Typical lifecycle
+
+1. Create an empty template
+
+```bash
+zinkee --json document-templates create --name "Quarterly report"
+```
+
+2. Upload one or more asset files
+
+```bash
+zinkee --json document-templates assets add "Quarterly report" ./requirements.docx
+zinkee --json document-templates assets add "Quarterly report" ./contract.docx --name "Customer Contract"
+```
+
+3. List and inspect
+
+```bash
+zinkee --json document-templates list
+zinkee --json document-templates get "Quarterly report"
+```
+
+4. Rename / replace assets / remove
+
+```bash
+zinkee --json document-templates update "Quarterly report" --name "Annual report"
+zinkee --json document-templates assets delete <template-uuid> <asset-uuid>
+zinkee --json document-templates delete <template-uuid>
+```
+
+### Download asset bytes
+
+`download` streams raw bytes — use `--output` to write to disk (required when combined with `--json`):
+
+```bash
+zinkee --json document-templates assets download <template-uuid> <asset-uuid> --output ./contract.docx
+zinkee document-templates assets download <template-uuid> <asset-uuid> > contract.docx
+```
+
+### Notes
+
+- `get` is a client-side helper: the backend has no get-one endpoint, so the CLI filters the list response. Use `list` if you want everything in one call.
+- The `assets` returned by list/get include a relative `link` ready to call directly (it already includes both the templateId and assetId path segments).
+- Deleting a template removes its asset files from storage; record fields that referenced previously generated documents are not modified.
+- Use `--json --example document-templates <subcommand>` for canonical examples.
+
+---
+
 ## Discovery
 
 ```bash
@@ -665,5 +718,6 @@ zinkee --json displays list
 zinkee --json automations list
 zinkee --json automations plugins list
 zinkee --json automations connections list
+zinkee --json document-templates list
 zinkee --example <command path>
 ```