@fugood/bricks-cli 2.24.7 → 2.24.8

package/README.md

@@ -258,6 +258,55 @@ bricks media files <box-id> \
 bricks media file <file-id> [-j|--json]
 ```
 
+### Data Bank (Remote Properties)
+
+Manage the workspace Data Bank: settings and space keys go through the Workspace API
+(workspace token); property CRUD talks to the Data Bank API directly using a space key.
+On the first property command the CLI issues a key via the Workspace API and saves it
+to the active profile (`~/.bricks-cli/config.json`) — no manual setup needed.
+
+```bash
+# Workspace-level settings
+bricks data status [-j|--json]       # also shows the stored CLI key (masked)
+bricks data enable
+bricks data disable
+
+# Stored CLI key management
+bricks data login [--name <keyName>] # (re)issue a key and save it to the profile
+bricks data logout [--revoke]        # remove the stored key; --revoke also revokes it
+
+# Space key management (human output masks key values; --json includes them)
+bricks data keys list [-j|--json]
+bricks data keys new <name> \
+  [--expire-at <ISO date>] \          # between 1 hour and 90 days from now
+  [--read <propId,...>] \             # limit readable properties
+  [--write <propId,...>] \            # limit writable properties
+  [-j|--json]
+bricks data keys revoke <keyValue|name> [-y] [-j|--json]
+
+# Property CRUD (Data Bank API, uses the stored key)
+bricks data list [-k keyword] [-m InSubspace|Global] [-j|--json]
+bricks data get <propertyId> [-j|--json]
+bricks data set <propertyId> \
+  [-v <json-or-string> | --value-file <path>] \
+  [-d <definition-json> | --definition-file <path>] \
+  [-m InSubspace|Global] [-t tag1,tag2] [-n "<update note>"] \
+  [--no-upsert]  \                    # fail when the property does not exist
+  [--no-notify]  \                    # skip notifying subscribed devices
+  [--dry-run] [-j|--json]
+bricks data remove <propertyId> [-y] [--dry-run] [-j|--json]
+```
+
+Notes:
+- `set` is an upsert by default and notifies subscribed devices, the same as editing in the controller Bank page.
+- When no `-v/--value-file` is given, `set` keeps the current value (useful to change only tags or the definition).
+- `-v` parses the input as JSON and falls back to a plain string (`-v '{"a":1}'` → object, `-v hello` → string).
+- Revoking the auto-provisioned `manager` / `used-by-device` keys rotates them instead of deleting them.
+- The Data Bank endpoint is derived from the configured BRICKS endpoint
+  (prod → `bank.bricks.tools`, beta → `bank-beta.bricks.tools`, dev → `localhost:8080`).
+- Environment overrides for CI / custom setups: `BRICKS_BANK_SPACENAME` + `BRICKS_BANK_SPACEKEY`
+  (skip the stored key) and `BRICKS_BANK_ENDPOINT` (custom Bank URL).
+
 ### Interactive Mode
 
 ```bash