@hardfin/cli 0.0.2-dev.11 → 0.0.2-dev.13

package/README.md

@@ -47,9 +47,39 @@ and the shape of the last segment decide the verb.
 | `PATCH /asset/{assetKey}` | `hardfin asset update <assetKey>` |
 | `PATCH /asset/{assetKey}/accounting` | `hardfin asset accounting update <assetKey>` |
 
-A path parameter becomes a positional argument. A query parameter becomes a flag, named in
-kebab case, and an array parameter becomes a flag you repeat. An enum parameter carries its
-values, so a wrong value fails locally with exit code 2 rather than at the API.
+Everything an endpoint takes becomes a flag or an argument. No command asks for JSON.
+
+| The document says | You type |
+| --- | --- |
+| A path parameter | a positional argument |
+| A query or body field | `--field-name`, in kebab case |
+| A field inside a nested object | `--address-city`, the path joined |
+| An array of values | the flag, repeated |
+| An array of objects | the flag, repeated, each carrying that element's fields as `key=value` |
+| A file upload | `--file <path>`, sent as multipart |
+
+```sh
+hardfin asset ownership create ast_4f9xk2mq7plr8stz \
+  --customer-id cst_a1 --date 2026-09-23 --sale-price 1500.00
+
+hardfin asset move execute create \
+  --move assetId=ast_a1,locationId=loc_x \
+  --move assetId=ast_b2,locationId=loc_y
+```
+
+A value is sent as the type the document names. `--useful-life 36` sends the number 36. A
+decimal such as `--salvage-value 1500.00` stays a string, which is how the API takes money
+without losing precision.
+
+Clear a field with `--unset`, naming the flag:
+
+```sh
+hardfin asset accounting update ast_4f9xk2mq7plr8stz --unset useful-life
+```
+
+Three things fail locally with exit code 2, before any request is made: a value outside an
+enum, a required field that is missing, and `--unset` on a field the API will not take null
+for.
 
 ### Overrides
 
@@ -185,6 +215,17 @@ environment, so `hardfin login` works out of the box.
 | `clientId`, or `HARDFIN_CLIENT_ID` | the client this CLI names itself as | the seeded Hardfin CLI client |
 | `issuerUrl`, or `HARDFIN_ISSUER_URL` | the authorization server | the API's host root |
 
+## Completing commands in your shell
+
+```sh
+source <(hardfin completion zsh)     # this shell, now
+hardfin completion zsh >> ~/.zshrc   # every shell after this one
+```
+
+`bash`, `zsh`, `fish` and `powershell` each get a script. The script asks the CLI what may
+follow what you have typed, so completions never fall behind the commands, including the ones
+generated from the API document.
+
 ## Serving an agent
 
 ```sh