neozip-cli 0.90.0 → 0.95.1

package/skills/neozip-shared/SKILL.md

@@ -0,0 +1,60 @@
+---
+name: neozip-shared
+description: "NeoZip global flags for agents: JSON output, --params/--json input, schema introspection, dry-run, and exit codes. Prerequisite for the other neozip skills."
+metadata:
+  version: 0.90.0
+  openclaw:
+    category: "productivity"
+    requires:
+      bins:
+        - neozip
+        - neounzip
+        - neolist
+    cliHelp: "neozip --help"
+---
+
+# NeoZip — shared agent conventions
+
+Read this before the per-command skills. It applies to `neozip`, `neounzip`, and
+`neolist`.
+
+## Get machine-readable output
+
+Add `--format json` to any command. Output is a single JSON object on stdout:
+
+- Success: `{ "ok": true, ... }`
+- Error:   `{ "ok": false, "error": { "code", "exitCode", "message", "nextCommand"? } }`
+
+stdout carries only the JSON object. Human hints/progress go to stderr. Always
+parse stdout; never parse human text.
+
+## Introspect before calling
+
+```bash
+neozip schema neozip      # or: neounzip | neolist | connect
+```
+
+Returns accepted `--params` fields, the `--json` payload shape, defaults, and
+exit codes. Use it to build your `--params`/`--json` objects.
+
+## Provide input as JSON
+
+- `--params '<JSON>'` — options ("how").
+- `--json '<JSON>'` — payload ("what": archive + files/targets).
+- Either accepts `-` to read JSON from stdin.
+- Explicit CLI flags override values from `--params`/`--json`.
+
+## Always dry-run mutations first
+
+```bash
+neozip --format json --dry-run --json '{"archive":"out.zip","files":["src/"]}'
+neounzip --format json --dry-run --params '{"exdir":"out"}' in.zip
+```
+
+`--dry-run` resolves the full plan and writes nothing.
+
+## Branch on exit codes
+
+Exit codes are InfoZip-compatible and echoed in `error.exitCode`. Common:
+`0` success, `10` parameter/option error, `9` files not found, `82` bad password.
+When an error includes `nextCommand`, run it to recover.