@fugood/bricks-cli 2.25.0-beta.8 → 2.25.0-beta.80

package/README.md

@@ -15,11 +15,15 @@ npm install -g @fugood/bricks-cli
 ## Quick Start
 
 ```bash
-# Login with a one-time passcode (recommended)
-bricks auth login <passcode>
+# Sign in with your BRICKS account (opens the browser, recommended)
+bricks auth login
 
-# Or login with your workspace token directly
-bricks auth login-token -t <your-workspace-token>
+# Select a workspace as the active profile
+bricks auth use-workspace
+
+# Workspace auth for CI/automation: one-time passcode or token
+bricks auth login-workspace <passcode>
+bricks auth login-workspace --token <your-workspace-token>
 
 # Check connection status
 bricks auth status
@@ -44,54 +48,78 @@ bricks media boxes
 
 ## Authentication Methods
 
-### Method 1: One-Time Passcode (Recommended)
+### Method 1: OAuth Sign-in (Recommended)
 
-The easiest way to authenticate is using a one-time passcode:
+Sign in with your BRICKS account — the CLI opens your browser (Authorization
+Code + PKCE against Auth0) and keeps the session refreshed automatically:
 
-1. Go to [BRICKS Controller](https://control.bricks.tools)
-2. Navigate to Workspace Settings > API Token
-3. Click "Create CLI Passcode"
-4. Use the passcode in the CLI:
-   ```bash
-   bricks auth login <passcode>
-   ```
+```bash
+bricks auth login              # opens the browser
+bricks auth login --no-browser # device-code flow for SSH/headless terminals
+```
+
+Only one account can be signed in at a time; signing in again replaces the
+identity (saved profiles are kept). After signing in, pick which workspaces to
+work with — each becomes a profile:
+
+```bash
+bricks auth workspaces         # list workspaces your account can access
+bricks auth use-workspace      # interactive picker (or pass an id/name)
+```
+
+OAuth profiles authorize by your role in the workspace — the same permissions
+you have in the web controller. `bricks auth logout` revokes the session;
+profiles remain and reactivate on the next login.
 
-The passcode is valid for 5 minutes and can only be used once. This method is more secure as you don't need to copy/paste long tokens.
+> Note: OAuth login requires the Auth0 native client to be configured in the
+> build (or `BRICKS_OAUTH_CLIENT_ID`). Until then, use workspace auth below.
 
-### Method 2: Direct Token
+### Method 2: Workspace Auth (CI / automation)
 
-You can also login with a workspace token directly:
+Workspace tokens are scoped, self-contained credentials — ideal for CI:
 
 1. Go to [BRICKS Controller](https://control.bricks.tools)
 2. Navigate to Workspace Settings > API Token
-3. Generate a new token with the required permissions
-4. Use the token in the CLI:
+3. Click "Generate OTP" (valid 5 minutes, single use) or create a token
+4. Use it in the CLI:
    ```bash
-   bricks auth login-token -t <your-workspace-token>
+   bricks auth login-workspace <passcode>
+   bricks auth login-workspace --token <your-workspace-token>
    ```
 
+> `bricks auth login <passcode>` remains as a deprecated alias for
+> `bricks auth login-workspace <passcode>`; `bricks auth login` without a
+> passcode now performs the OAuth browser sign-in. `login-token` is also deprecated.
+
 ## Commands
 
 ### Authentication
 
 ```bash
-# Login with one-time passcode (recommended)
-bricks auth login <passcode> [-p profile-name]
+# Sign in with your BRICKS account (OAuth via browser)
+bricks auth login [--no-browser]
+
+# List workspaces / select one as the active profile
+bricks auth workspaces [-j|--json]
+bricks auth use-workspace [workspace] [-p profile-name]
 
-# Login with token
-bricks auth login-token -t <token> [-p profile-name]
+# Workspace auth (one-time passcode or token)
+bricks auth login-workspace [passcode] [--token <token>] [-p profile-name]
 
 # Check status
 bricks auth status [-j|--json]
 
-# List all profiles
+# List all profiles (kind: oauth | token)
 bricks auth list
 
 # Switch profile
 bricks auth use <profile-name>
 
-# Logout
-bricks auth logout [-p profile-name] [--all]
+# Sign out of the OAuth session (profiles are kept; --all removes them too)
+bricks auth logout [--all]
+
+# Remove a saved profile
+bricks auth remove <profile-name>
 
 # Set custom API URL
 bricks auth set-url <url>
@@ -187,7 +215,13 @@ bricks app bind <app-id> [-b device-ids] [-u device-ids] [--dry-run] [-j|--json]
 bricks app trigger <app-id> <test-id> [--play|--stop] [--setup-at-launch]
 
 # Preview a release without publishing
-bricks app release <app-id> -c <config-path-or-json> [--dry-run] [-j|--json]
+bricks app release <app-id> -c <config-path-or-json> [-n name] [--version version] [--changelogs text] [--dry-run] [-j|--json]
+
+# Diagnose a config: schema validation + semantic lint rules
+# (data-update-race, redundant-rect-overlay, off-grid-frame, out-of-bounds-frame,
+#  wait-async-no-op, missing-result-param, unused-data-node, z-order-cover)
+# Accepts a local file path or a remote application id.
+bricks app doctor <app-id-or-path> [-c|--composed] [--strict] [--only codes] [--ignore codes] [-j|--json]
 ```
 
 ### Module Management
@@ -209,7 +243,11 @@ bricks module update <module-id> [-n name] [-d description] [-c config-json] [-f
 bricks module short-edit <module-id> -l '[{"shortId":"<subspace-short-id>","path":"property.name","content":"value"}]'
 
 # Preview a release without publishing
-bricks module release <module-id> -c <config-path-or-json> [--dry-run] [-j|--json]
+bricks module release <module-id> -c <config-path-or-json> [-n name] [--version version] [--changelogs text] [--dry-run] [-j|--json]
+
+# Diagnose a module config (same rules as `app doctor`; the root subspace's
+# data nodes are treated as the module's exposed interface)
+bricks module doctor <module-id-or-path> [--strict] [--only codes] [--ignore codes] [-j|--json]
 ```
 
 ### Device Group Management
@@ -258,6 +296,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

package/lib/1001.js

@@ -0,0 +1 @@
+import*as e from"ink";import*as r from"react";import*as o from"react/jsx-runtime";export const __rspack_esm_id=1001;export const __rspack_esm_ids=[1001];export const __webpack_modules__={8498(r){r.exports=e},51649(e){e.exports=r},71178(e){e.exports=o},52928(e,r,o){o.r(r),o.d(r,{WorkspacePicker:()=>l,applyWorkspaceSearchInput:()=>i,filterWorkspaces:()=>a});var t=o(68832),s=o(51649),c=o(8498),n=o(71178),a=(e,r)=>{var o=r.trim().toLowerCase();return o?e.filter(e=>[e.name,e._id].some(e=>String(e||"").toLowerCase().includes(o))):e},i=(e,r,o={})=>o.backspace||o.delete?e.slice(0,-1):!r||o.ctrl||o.meta?e:e+r,l=({workspaces:e,onSelect:r,onCancel:o})=>{var l=t((0,s.useState)(""),2),x=l[0],d=l[1],p=t((0,s.useState)(0),2),m=p[0],h=p[1],u=(0,s.useMemo)(()=>a(e,x),[e,x]);(0,c.useInput)((e,t)=>{if(t.escape)return void o();if(t.upArrow||t.downArrow){if(0===u.length)return;var s=t.upArrow?-1:1;h(e=>(e+s+u.length)%u.length);return}if(t.return){var c=u[m];c&&r(c);return}var n=i(x,e,t);n!==x&&(d(n),h(0))});var j=Math.min(Math.max(m-Math.floor(5),0),Math.max(u.length-10,0)),_=u.slice(j,j+10);return(0,n.jsxs)(c.Box,{flexDirection:"column",children:[(0,n.jsx)(c.Text,{bold:!0,children:"Select a workspace"}),(0,n.jsxs)(c.Box,{marginTop:1,children:[(0,n.jsx)(c.Text,{children:"Search: "}),x?(0,n.jsx)(c.Text,{color:"cyan",children:x}):(0,n.jsx)(c.Text,{dimColor:!0,children:"Name or workspace ID"}),(0,n.jsx)(c.Text,{inverse:!0,children:" "})]}),(0,n.jsx)(c.Box,{marginTop:1,flexDirection:"column",children:_.length>0?_.map((e,r)=>{var o=j+r===m;return(0,n.jsxs)(c.Box,{children:[(0,n.jsx)(c.Text,{color:o?"cyan":void 0,children:o?"❯ ":"  "}),(0,n.jsx)(c.Text,{color:o?"cyan":void 0,children:e.name}),(0,n.jsxs)(c.Text,{dimColor:!0,children:[" ",e._id]})]},e._id)}):(0,n.jsx)(c.Text,{color:"yellow",children:"No matching workspaces"})}),(0,n.jsx)(c.Box,{marginTop:1,children:(0,n.jsx)(c.Text,{dimColor:!0,children:"Type anywhere to search \xb7 ↑/↓ navigate \xb7 Enter select \xb7 Esc cancel"})})]})}}};