@fugood/bricks-cli 2.24.0-beta.43 → 2.24.0-beta.45

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -23,9 +23,14 @@ bricks auth login-token -t <your-workspace-token>
23
23
 
24
24
  # Check connection status
25
25
  bricks auth status
26
+ bricks auth status --json
27
+
28
+ # Machine-readable environment check
29
+ bricks doctor --json
26
30
 
27
31
  # List devices
28
32
  bricks device list
33
+ bricks device resolve "Lobby"
29
34
 
30
35
  # Start interactive mode
31
36
  bricks interactive
@@ -77,7 +82,7 @@ bricks auth login <passcode> [-p profile-name]
77
82
  bricks auth login-token -t <token> [-p profile-name]
78
83
 
79
84
  # Check status
80
- bricks auth status
85
+ bricks auth status [-j|--json]
81
86
 
82
87
  # List all profiles
83
88
  bricks auth list
@@ -92,6 +97,14 @@ bricks auth logout [-p profile-name] [--all]
92
97
  bricks auth set-url <url>
93
98
  ```
94
99
 
100
+ ### Doctor
101
+
102
+ ```bash
103
+ # Check config, auth, workspace reachability, MCP availability
104
+ bricks doctor
105
+ bricks doctor --json
106
+ ```
107
+
95
108
  ### Configuration
96
109
 
97
110
  ```bash
@@ -113,16 +126,20 @@ bricks config show [-j|--json]
113
126
  # List all devices
114
127
  bricks device list [-k keyword] [-j|--json]
115
128
 
129
+ # Resolve a device name or ID
130
+ bricks device resolve <query> [-l limit] [-j|--json]
131
+
116
132
  # Get device details
117
133
  bricks device get <device-id> [-j|--json]
118
134
 
119
135
  # Bind a new device with passcode
120
136
  bricks device bind <passcode> [-n device-name]
137
+ bricks device bind <passcode> [--dry-run] [-j|--json]
121
138
 
122
139
  # Control device
123
- bricks device control <device-id> <type> [-p payload]
124
- bricks device refresh <device-id>
125
- bricks device clear-cache <device-id>
140
+ bricks device control <device-id> <type> [-p payload] [--dry-run] [-j|--json]
141
+ bricks device refresh <device-id> [--dry-run] [-j|--json]
142
+ bricks device clear-cache <device-id> [--dry-run] [-j|--json]
126
143
  bricks device screenshot <device-id>
127
144
 
128
145
  # Monitor devices (real-time polling)
@@ -137,6 +154,9 @@ Control types: `refresh`, `clear-cache`, `take-screenshot`, `system-menu`, `syst
137
154
  # List applications
138
155
  bricks app list [-k keyword] [-j|--json]
139
156
 
157
+ # Resolve an application name or ID
158
+ bricks app resolve <query> [-l limit] [-j|--json]
159
+
140
160
  # Get application details
141
161
  bricks app get <app-id> [-c|--composed] [-j|--json]
142
162
 
@@ -148,9 +168,13 @@ bricks app short-edit <app-id> -l '[{"shortId":"<subspace-short-id>","path":"pro
148
168
 
149
169
  # Bind/unbind devices
150
170
  bricks app bind <app-id> [-b device-ids] [-u device-ids]
171
+ bricks app bind <app-id> [-b device-ids] [-u device-ids] [--dry-run] [-j|--json]
151
172
 
152
173
  # Trigger automation
153
174
  bricks app trigger <app-id> <test-id> [--play|--stop] [--setup-at-launch]
175
+
176
+ # Preview a release without publishing
177
+ bricks app release <app-id> -c <config-path-or-json> [--dry-run] [-j|--json]
154
178
  ```
155
179
 
156
180
  ### Module Management
@@ -159,6 +183,9 @@ bricks app trigger <app-id> <test-id> [--play|--stop] [--setup-at-launch]
159
183
  # List modules
160
184
  bricks module list [-k keyword] [-j|--json]
161
185
 
186
+ # Resolve a module name or ID
187
+ bricks module resolve <query> [-l limit] [-j|--json]
188
+
162
189
  # Get module details
163
190
  bricks module get <module-id> [-j|--json]
164
191
 
@@ -167,6 +194,9 @@ bricks module update <module-id> [-n name] [-d description] [-c config-json] [-f
167
194
 
168
195
  # Short edit module (requires valid shortIds from module config)
169
196
  bricks module short-edit <module-id> -l '[{"shortId":"<subspace-short-id>","path":"property.name","content":"value"}]'
197
+
198
+ # Preview a release without publishing
199
+ bricks module release <module-id> -c <config-path-or-json> [--dry-run] [-j|--json]
170
200
  ```
171
201
 
172
202
  ### Device Group Management
@@ -175,6 +205,9 @@ bricks module short-edit <module-id> -l '[{"shortId":"<subspace-short-id>","path
175
205
  # List device groups
176
206
  bricks group list [-j|--json]
177
207
 
208
+ # Resolve a device group name or ID
209
+ bricks group resolve <query> [-l limit] [-j|--json]
210
+
178
211
  # Get group details
179
212
  bricks group get <group-id> [-j|--json]
180
213
 
@@ -182,8 +215,8 @@ bricks group get <group-id> [-j|--json]
182
215
  bricks group devices <group-id> [-j|--json]
183
216
 
184
217
  # Dispatch action to all devices
185
- bricks group dispatch <group-id> <action>
186
- bricks group refresh <group-id>
218
+ bricks group dispatch <group-id> <action> [--dry-run] [-j|--json]
219
+ bricks group refresh <group-id> [--dry-run] [-j|--json]
187
220
 
188
221
  # Monitor group (real-time polling)
189
222
  bricks group monitor <group-id> [-i interval-seconds]
@@ -219,6 +252,7 @@ bricks media file <file-id> [-j|--json]
219
252
  bricks interactive
220
253
  # or
221
254
  bricks i
255
+ # or just run `bricks` from a TTY
222
256
  ```
223
257
 
224
258
  The interactive mode provides a terminal UI built with [Ink](https://github.com/vadimdemedes/ink) for:
@@ -234,6 +268,8 @@ Controls:
234
268
  - `Esc`: Go back
235
269
  - `q`: Quit
236
270
 
271
+ When `bricks` is run without arguments in a non-TTY context such as Codex, CI, or shell pipelines, it prints help instead of launching Ink.
272
+
237
273
  ### Workspace Info
238
274
 
239
275
  ```bash
@@ -249,7 +285,7 @@ Configuration is stored in `~/.bricks-cli/config.json`:
249
285
  - API endpoint configuration (prod/beta/dev)
250
286
  - Token storage
251
287
 
252
- Use `bricks config show` to view current settings or `bricks config endpoint` to switch environments.
288
+ Use `bricks config show` to view current settings, `bricks config endpoint` to switch environments, or `bricks doctor --json` for a machine-readable health check.
253
289
 
254
290
  ## Development
255
291