@descix/platform-api 4.0.0 → 4.0.1

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.
@@ -0,0 +1,2123 @@
1
+ [
2
+ {
3
+ "verbPath": "admin-login",
4
+ "description": "Bootstrap CLI credentials for platform admins (requires admin group membership)",
5
+ "arguments": [],
6
+ "options": [
7
+ {
8
+ "flags": "-e, --email <email>",
9
+ "description": "Admin email (must be in platform admin Google Group)",
10
+ "required": true
11
+ },
12
+ {
13
+ "flags": "-u, --url <url>",
14
+ "description": "API URL override",
15
+ "required": false
16
+ }
17
+ ],
18
+ "runbookAnchor": null
19
+ },
20
+ {
21
+ "verbPath": "app delete",
22
+ "description": "Delete an app with full cascade cleanup (Pinecone, GCS, Firestore, Products)",
23
+ "arguments": [],
24
+ "options": [
25
+ {
26
+ "flags": "-a, --app <app_id>",
27
+ "description": "App ID to delete",
28
+ "required": true
29
+ },
30
+ {
31
+ "flags": "-c, --community <community_id>",
32
+ "description": "Community ID (auto-resolved from Products if omitted)",
33
+ "required": false
34
+ },
35
+ {
36
+ "flags": "--dry-run",
37
+ "description": "Preview what would be deleted without executing",
38
+ "required": false
39
+ },
40
+ {
41
+ "flags": "--soft",
42
+ "description": "Soft delete only (mark as hidden, no cascade)",
43
+ "required": false
44
+ },
45
+ {
46
+ "flags": "--yes",
47
+ "description": "Skip confirmation prompt",
48
+ "required": false
49
+ }
50
+ ],
51
+ "runbookAnchor": null
52
+ },
53
+ {
54
+ "verbPath": "app init",
55
+ "description": "Create (if needed) and initialize an app: platform record + default KB + local workspace registration and scaffold. Idempotent. Pass -c to create a new app; omit it to initialize one that already exists.",
56
+ "arguments": [],
57
+ "options": [
58
+ {
59
+ "flags": "-a, --app <app_id>",
60
+ "description": "App ID (e.g. daita). With -c this is the app NAME to create.",
61
+ "required": true
62
+ },
63
+ {
64
+ "flags": "-c, --community <id>",
65
+ "description": "Community ID — REQUIRED to create an app that does not exist yet. The community must already be materialized in this environment.",
66
+ "required": false
67
+ },
68
+ {
69
+ "flags": "-s, --short <short_name>",
70
+ "description": "SHORT id segment (no hyphens) used when creating; the app_id is composed server-side as {community}-{short}. Defaults to --app.",
71
+ "required": false
72
+ },
73
+ {
74
+ "flags": "--overwrite",
75
+ "description": "When creating, overwrite an existing app record intentionally",
76
+ "required": false
77
+ },
78
+ {
79
+ "flags": "--kb <name>",
80
+ "description": "Knowledge base name",
81
+ "required": false
82
+ }
83
+ ],
84
+ "runbookAnchor": "#_4-connect-the-repository-to-its-app"
85
+ },
86
+ {
87
+ "verbPath": "app invite",
88
+ "description": "Generate invite links to share your app",
89
+ "arguments": [],
90
+ "options": [
91
+ {
92
+ "flags": "-a, --app <id>",
93
+ "description": "App ID",
94
+ "required": true
95
+ },
96
+ {
97
+ "flags": "--type <type>",
98
+ "description": "Invite type: try or install",
99
+ "required": false
100
+ },
101
+ {
102
+ "flags": "--hint <text>",
103
+ "description": "Context for the AI agent (e.g., \"Physics students, no coding background\")",
104
+ "required": false
105
+ },
106
+ {
107
+ "flags": "--expires <duration>",
108
+ "description": "Expiry duration (e.g., 30d, 7d, 24h)",
109
+ "required": false
110
+ }
111
+ ],
112
+ "runbookAnchor": null
113
+ },
114
+ {
115
+ "verbPath": "app list",
116
+ "description": "List apps you have access to (purchases + owned)",
117
+ "arguments": [],
118
+ "options": [],
119
+ "runbookAnchor": null
120
+ },
121
+ {
122
+ "verbPath": "app media-upload",
123
+ "description": "Upload media/asset files to an app's GCS assets prefix (200 MB per app today; app owners, community admins and platform admins may upload — returns asset references)",
124
+ "arguments": [],
125
+ "options": [
126
+ {
127
+ "flags": "-a, --app <id>",
128
+ "description": "App ID (community is resolved server-side from Products)",
129
+ "required": true
130
+ },
131
+ {
132
+ "flags": "-f, --file <path...>",
133
+ "description": "One or more local file paths to upload",
134
+ "required": true
135
+ },
136
+ {
137
+ "flags": "--prefix <relPath>",
138
+ "description": "Optional sub-path under the app assets/ prefix (e.g. \"shows/myshow\")",
139
+ "required": false
140
+ },
141
+ {
142
+ "flags": "--json",
143
+ "description": "Print the asset references as JSON (for scripting)",
144
+ "required": false
145
+ }
146
+ ],
147
+ "runbookAnchor": null
148
+ },
149
+ {
150
+ "verbPath": "app open",
151
+ "description": "Resolve (and optionally open) an app's local gateway dev URL. Hard-fails if the app has no site config.",
152
+ "arguments": [],
153
+ "options": [
154
+ {
155
+ "flags": "-a, --app <app_id>",
156
+ "description": "App ID (an app this workspace serves, with a site)",
157
+ "required": true
158
+ },
159
+ {
160
+ "flags": "--open",
161
+ "description": "Open the resolved URL in the default browser",
162
+ "required": false
163
+ }
164
+ ],
165
+ "runbookAnchor": null
166
+ },
167
+ {
168
+ "verbPath": "app records delete",
169
+ "description": "Delete records by id (or by file_id grouping key)",
170
+ "arguments": [],
171
+ "options": [
172
+ {
173
+ "flags": "-a, --app <app_id>",
174
+ "description": "App ID",
175
+ "required": true
176
+ },
177
+ {
178
+ "flags": "-k, --kb <kb_id>",
179
+ "description": "Record collection ID",
180
+ "required": true
181
+ },
182
+ {
183
+ "flags": "-i, --ids <csv>",
184
+ "description": "Comma-separated record ids to delete",
185
+ "required": false
186
+ },
187
+ {
188
+ "flags": "--file-ids <csv>",
189
+ "description": "Comma-separated file_id grouping keys to delete",
190
+ "required": false
191
+ }
192
+ ],
193
+ "runbookAnchor": null
194
+ },
195
+ {
196
+ "verbPath": "app records get",
197
+ "description": "Fetch specific records by id (point lookup) with an arbitrary metadata projection",
198
+ "arguments": [],
199
+ "options": [
200
+ {
201
+ "flags": "-a, --app <app_id>",
202
+ "description": "App ID",
203
+ "required": true
204
+ },
205
+ {
206
+ "flags": "-k, --kb <kb_id>",
207
+ "description": "Record collection ID",
208
+ "required": true
209
+ },
210
+ {
211
+ "flags": "-i, --ids <csv>",
212
+ "description": "Comma-separated record ids to fetch",
213
+ "required": true
214
+ },
215
+ {
216
+ "flags": "--fields <csv>",
217
+ "description": "Comma-separated metadata projection (omit or \"*\" for all metadata)",
218
+ "required": false
219
+ }
220
+ ],
221
+ "runbookAnchor": null
222
+ },
223
+ {
224
+ "verbPath": "app records put",
225
+ "description": "Store/replace records in your app data store with custom metadata (your app as a database table). You supply file_id (+ optional chunk_idx); the id is built for you.",
226
+ "arguments": [],
227
+ "options": [
228
+ {
229
+ "flags": "-a, --app <app_id>",
230
+ "description": "App ID",
231
+ "required": true
232
+ },
233
+ {
234
+ "flags": "-k, --kb <kb_id>",
235
+ "description": "Record collection ID (acts like a table)",
236
+ "required": true
237
+ },
238
+ {
239
+ "flags": "-r, --records <json>",
240
+ "description": "JSON array of records: [{ \"file_id\", \"text\"?, \"chunk_idx\"?, ...customMetadata }] — id is built from file_id (+ chunk_idx); pass a full \"id\" only for back-compat. Example: '[{\"file_id\":\"e1\",\"text\":\"...\",\"type\":\"episode\",\"show\":\"x\"}]'",
241
+ "required": true
242
+ },
243
+ {
244
+ "flags": "--mode <mode>",
245
+ "description": "upsert (default) | create — \"create\" is an atomic all-or-nothing conditional create: it fails if any key already exists and reports who holds it, instead of overwriting",
246
+ "required": false
247
+ }
248
+ ],
249
+ "runbookAnchor": null
250
+ },
251
+ {
252
+ "verbPath": "app records query",
253
+ "description": "STRUCTURED metadata-filtered scan (non-ANN) returning full records: \"all records where type=episode AND show=X\"",
254
+ "arguments": [],
255
+ "options": [
256
+ {
257
+ "flags": "-a, --app <app_id>",
258
+ "description": "App ID",
259
+ "required": true
260
+ },
261
+ {
262
+ "flags": "-k, --kb <kb_id>",
263
+ "description": "Record collection ID",
264
+ "required": true
265
+ },
266
+ {
267
+ "flags": "-f, --filter <json>",
268
+ "description": "Metadata predicate JSON. Scalar fields: $eq/$ne/$in or a bare value; ARRAY fields: $contains. e.g. '{\"type\":\"episode\",\"tags\":{\"$contains\":\"handoff\"}}'",
269
+ "required": false
270
+ },
271
+ {
272
+ "flags": "--fields <csv>",
273
+ "description": "Comma-separated metadata projection (omit or \"*\" for all metadata)",
274
+ "required": false
275
+ },
276
+ {
277
+ "flags": "--limit <n>",
278
+ "description": "Cap on returned records",
279
+ "required": false
280
+ }
281
+ ],
282
+ "runbookAnchor": null
283
+ },
284
+ {
285
+ "verbPath": "app set-api-url",
286
+ "description": "Set API base URL for app's own backend",
287
+ "arguments": [],
288
+ "options": [
289
+ {
290
+ "flags": "-c, --community <id>",
291
+ "description": "Community ID",
292
+ "required": true
293
+ },
294
+ {
295
+ "flags": "-a, --app <id>",
296
+ "description": "App ID",
297
+ "required": true
298
+ },
299
+ {
300
+ "flags": "-u, --url <url>",
301
+ "description": "API base URL (e.g., https://api.example.com)",
302
+ "required": true
303
+ }
304
+ ],
305
+ "runbookAnchor": null
306
+ },
307
+ {
308
+ "verbPath": "app set-default-model",
309
+ "description": "Set or clear App.default_app_model (model used when no KB override is set)",
310
+ "arguments": [],
311
+ "options": [
312
+ {
313
+ "flags": "-a, --app <app_id>",
314
+ "description": "App ID (e.g. unk-cos)",
315
+ "required": true
316
+ },
317
+ {
318
+ "flags": "-m, --model <model_name>",
319
+ "description": "Model name (e.g. gemini-3.8-flash). Mutually exclusive with --clear.",
320
+ "required": false
321
+ },
322
+ {
323
+ "flags": "--clear",
324
+ "description": "Delete App.default_app_model via FieldValue.delete() (resets to platform-default inheritance)",
325
+ "required": false
326
+ }
327
+ ],
328
+ "runbookAnchor": null
329
+ },
330
+ {
331
+ "verbPath": "app set-listed",
332
+ "description": "List or unlist your app in the app store (on: shown in the public store; off: not shown to non-admin visitors)",
333
+ "arguments": [
334
+ {
335
+ "name": "state",
336
+ "required": true,
337
+ "variadic": false,
338
+ "description": "on or off"
339
+ }
340
+ ],
341
+ "options": [
342
+ {
343
+ "flags": "-c, --community <id>",
344
+ "description": "Community ID",
345
+ "required": true
346
+ },
347
+ {
348
+ "flags": "-a, --app <id>",
349
+ "description": "App ID",
350
+ "required": true
351
+ }
352
+ ],
353
+ "runbookAnchor": "#_9-list-it-and-discover-the-rest"
354
+ },
355
+ {
356
+ "verbPath": "app set-name",
357
+ "description": "Set app display name",
358
+ "arguments": [],
359
+ "options": [
360
+ {
361
+ "flags": "-c, --community <id>",
362
+ "description": "Community ID",
363
+ "required": true
364
+ },
365
+ {
366
+ "flags": "-a, --app <id>",
367
+ "description": "App ID",
368
+ "required": true
369
+ },
370
+ {
371
+ "flags": "--name <name>",
372
+ "description": "Display name for the app",
373
+ "required": true
374
+ }
375
+ ],
376
+ "runbookAnchor": null
377
+ },
378
+ {
379
+ "verbPath": "app set-port",
380
+ "description": "Set the microservice port for this workspace's app (writes env.app.microservice.port). Pass \"n\" to remove.",
381
+ "arguments": [],
382
+ "options": [
383
+ {
384
+ "flags": "-a, --app <app_id>",
385
+ "description": "App ID (must be this workspace's app, env.app)",
386
+ "required": true
387
+ },
388
+ {
389
+ "flags": "-p, --port <port>",
390
+ "description": "Microservice port number (1-65535), or \"n\" to remove",
391
+ "required": true
392
+ }
393
+ ],
394
+ "runbookAnchor": null
395
+ },
396
+ {
397
+ "verbPath": "app set-price",
398
+ "description": "Set app price in USDCX",
399
+ "arguments": [],
400
+ "options": [
401
+ {
402
+ "flags": "-c, --community <id>",
403
+ "description": "Community ID",
404
+ "required": true
405
+ },
406
+ {
407
+ "flags": "-a, --app <id>",
408
+ "description": "App ID",
409
+ "required": true
410
+ },
411
+ {
412
+ "flags": "-p, --price <amount>",
413
+ "description": "Price in USDCX (decimal number)",
414
+ "required": true
415
+ }
416
+ ],
417
+ "runbookAnchor": null
418
+ },
419
+ {
420
+ "verbPath": "app set-repo",
421
+ "description": "Link a GitHub repository to your app",
422
+ "arguments": [],
423
+ "options": [
424
+ {
425
+ "flags": "-a, --app <id>",
426
+ "description": "App ID",
427
+ "required": true
428
+ },
429
+ {
430
+ "flags": "--repo <url>",
431
+ "description": "SSH git URL (e.g., git@github.com:user/repo.git)",
432
+ "required": false
433
+ },
434
+ {
435
+ "flags": "--unlink",
436
+ "description": "Remove the linked repository",
437
+ "required": false
438
+ },
439
+ {
440
+ "flags": "--branch <name>",
441
+ "description": "Default branch",
442
+ "required": false
443
+ },
444
+ {
445
+ "flags": "--subfolder <path>",
446
+ "description": "Subfolder within repo",
447
+ "required": false
448
+ }
449
+ ],
450
+ "runbookAnchor": null
451
+ },
452
+ {
453
+ "verbPath": "app set-site",
454
+ "description": "Set this workspace app's site config (env.app.site). One active mode per write: --static <dir> (built site served at /p/<app>/) or --port <n> [--protocol http|https] (dev server proxied at /p/<app>); setting one clears the other. Pass both flags together to keep both — the gateway then serves the dev server (site.port wins). --unset clears site.{} entirely.",
455
+ "arguments": [],
456
+ "options": [
457
+ {
458
+ "flags": "-a, --app <app_id>",
459
+ "description": "App ID (must be this workspace's app, env.app)",
460
+ "required": true
461
+ },
462
+ {
463
+ "flags": "--static <path>",
464
+ "description": "Static mode: a dir relative to the workspace root (the repo root), e.g. \"site\" or \"../scratch\"; \".\" = the root itself. An absolute path is refused. Alone, it clears site.port and site.protocol (one active mode per write).",
465
+ "required": false
466
+ },
467
+ {
468
+ "flags": "--port <port>",
469
+ "description": "Dev-server mode: proxy /p/<app> to your local dev server on this port (1-65535). Alone, it clears site.static. With --static in the same call, both are kept and the gateway serves the dev server.",
470
+ "required": false
471
+ },
472
+ {
473
+ "flags": "--protocol <scheme>",
474
+ "description": "Dev-server upstream scheme: \"http\" or \"https\" (default https when unset). Dev-server mode only — requires site.port. A wrong scheme fails loud at the gateway (502); there is no auto-detection.",
475
+ "required": false
476
+ },
477
+ {
478
+ "flags": "--unset",
479
+ "description": "Remove site.static, site.port and site.protocol for the app, clearing the site.{} slot",
480
+ "required": false
481
+ }
482
+ ],
483
+ "runbookAnchor": "#_5-run-it-locally-descix-serve"
484
+ },
485
+ {
486
+ "verbPath": "app sync-assets",
487
+ "description": "Sync local assets (system_instructions.md, app_description.md, icon.png) to platform.",
488
+ "arguments": [],
489
+ "options": [
490
+ {
491
+ "flags": "-a, --app <app_id>",
492
+ "description": "App ID",
493
+ "required": true
494
+ },
495
+ {
496
+ "flags": "-k, --kb <name>",
497
+ "description": "Target KB for system_instructions",
498
+ "required": false
499
+ },
500
+ {
501
+ "flags": "-p, --path <dir>",
502
+ "description": "App directory (default: auto-detected)",
503
+ "required": false
504
+ }
505
+ ],
506
+ "runbookAnchor": null
507
+ },
508
+ {
509
+ "verbPath": "buy chains",
510
+ "description": "List supported blockchains for payments",
511
+ "arguments": [],
512
+ "options": [],
513
+ "runbookAnchor": null
514
+ },
515
+ {
516
+ "verbPath": "buy poll",
517
+ "description": "Poll for quote status until completed (with exponential backoff)",
518
+ "arguments": [
519
+ {
520
+ "name": "quoteId",
521
+ "required": true,
522
+ "variadic": false,
523
+ "description": ""
524
+ }
525
+ ],
526
+ "options": [
527
+ {
528
+ "flags": "--max <attempts>",
529
+ "description": "Maximum poll attempts",
530
+ "required": false
531
+ },
532
+ {
533
+ "flags": "--interval <ms>",
534
+ "description": "Initial poll interval in ms",
535
+ "required": false
536
+ }
537
+ ],
538
+ "runbookAnchor": null
539
+ },
540
+ {
541
+ "verbPath": "buy quote",
542
+ "description": "Create a crypto payment quote",
543
+ "arguments": [],
544
+ "options": [
545
+ {
546
+ "flags": "-a, --amount <usd>",
547
+ "description": "USD amount to purchase",
548
+ "required": true
549
+ },
550
+ {
551
+ "flags": "-c, --chain <chain>",
552
+ "description": "Blockchain to use (polygon, ethereum, bnb)",
553
+ "required": true
554
+ },
555
+ {
556
+ "flags": "-t, --type <type>",
557
+ "description": "Purchase type: usdcx or community_token",
558
+ "required": false
559
+ },
560
+ {
561
+ "flags": "-e, --email <email>",
562
+ "description": "Email for claim link (guest mode)",
563
+ "required": false
564
+ },
565
+ {
566
+ "flags": "--community <id>",
567
+ "description": "Community ID for community token purchase",
568
+ "required": false
569
+ }
570
+ ],
571
+ "runbookAnchor": null
572
+ },
573
+ {
574
+ "verbPath": "buy status",
575
+ "description": "Check status of a payment quote",
576
+ "arguments": [
577
+ {
578
+ "name": "quoteId",
579
+ "required": true,
580
+ "variadic": false,
581
+ "description": ""
582
+ }
583
+ ],
584
+ "options": [],
585
+ "runbookAnchor": null
586
+ },
587
+ {
588
+ "verbPath": "chat",
589
+ "description": "Chat with an app agent. Usage: descix chat \"Your question\" or descix chat -q \"Your question\"",
590
+ "arguments": [
591
+ {
592
+ "name": "question",
593
+ "required": false,
594
+ "variadic": true,
595
+ "description": ""
596
+ }
597
+ ],
598
+ "options": [
599
+ {
600
+ "flags": "-c, --community <id>",
601
+ "description": "Community ID (optional; server resolves it from Products)",
602
+ "required": false
603
+ },
604
+ {
605
+ "flags": "-a, --app <id>",
606
+ "description": "App ID (required unless run from inside a mapped app directory)",
607
+ "required": false
608
+ },
609
+ {
610
+ "flags": "-q, --question <text>",
611
+ "description": "Question to ask (alternative to positional argument)",
612
+ "required": false
613
+ },
614
+ {
615
+ "flags": "-k, --kb <id...>",
616
+ "description": "Knowledge Base ID(s) — repeat for multi-KB, use * for all",
617
+ "required": false
618
+ },
619
+ {
620
+ "flags": "--apps <ids>",
621
+ "description": "Comma-separated app IDs for cross-app query",
622
+ "required": false
623
+ },
624
+ {
625
+ "flags": "--level <n>",
626
+ "description": "Intelligence level (1-5)",
627
+ "required": false
628
+ },
629
+ {
630
+ "flags": "--model <name>",
631
+ "description": "Explicit model override",
632
+ "required": false
633
+ },
634
+ {
635
+ "flags": "--thinking-level <level>",
636
+ "description": "Thinking level for this call: minimal, low, medium or high. The server refuses a level the resolved model does not support.",
637
+ "required": false
638
+ },
639
+ {
640
+ "flags": "--tokens",
641
+ "description": "Show token usage in response footer",
642
+ "required": false
643
+ },
644
+ {
645
+ "flags": "--new",
646
+ "description": "Start a new conversation (clear session)",
647
+ "required": false
648
+ }
649
+ ],
650
+ "runbookAnchor": "#_6-knowledge-bases"
651
+ },
652
+ {
653
+ "verbPath": "clone",
654
+ "description": "Clone a DeSciX app repository",
655
+ "arguments": [],
656
+ "options": [
657
+ {
658
+ "flags": "-a, --app <id>",
659
+ "description": "App ID",
660
+ "required": true
661
+ },
662
+ {
663
+ "flags": "--path <dir>",
664
+ "description": "Target directory",
665
+ "required": false
666
+ }
667
+ ],
668
+ "runbookAnchor": null
669
+ },
670
+ {
671
+ "verbPath": "community check-token",
672
+ "description": "Check if a token symbol is available",
673
+ "arguments": [
674
+ {
675
+ "name": "symbol",
676
+ "required": true,
677
+ "variadic": false,
678
+ "description": "Token symbol to check (1-7 chars)"
679
+ }
680
+ ],
681
+ "options": [],
682
+ "runbookAnchor": null
683
+ },
684
+ {
685
+ "verbPath": "community contract",
686
+ "description": "Get details about a deployed contract",
687
+ "arguments": [],
688
+ "options": [
689
+ {
690
+ "flags": "-a, --address <address>",
691
+ "description": "Contract address",
692
+ "required": false
693
+ },
694
+ {
695
+ "flags": "-t, --token <symbol>",
696
+ "description": "Token symbol",
697
+ "required": false
698
+ },
699
+ {
700
+ "flags": "-c, --community <id>",
701
+ "description": "Community ID",
702
+ "required": false
703
+ }
704
+ ],
705
+ "runbookAnchor": null
706
+ },
707
+ {
708
+ "verbPath": "community create",
709
+ "description": "Create a new community with token contract (requires platform admin, deploys to live Polygon)",
710
+ "arguments": [],
711
+ "options": [
712
+ {
713
+ "flags": "-n, --name <name>",
714
+ "description": "Community display name (e.g. \"SMILE\")",
715
+ "required": true
716
+ },
717
+ {
718
+ "flags": "-t, --token <symbol>",
719
+ "description": "Token symbol (e.g. SMILE)",
720
+ "required": true
721
+ },
722
+ {
723
+ "flags": "--icon <url>",
724
+ "description": "Icon URL for the community",
725
+ "required": false
726
+ },
727
+ {
728
+ "flags": "--yes",
729
+ "description": "Skip confirmation prompt (use with caution)",
730
+ "required": false
731
+ }
732
+ ],
733
+ "runbookAnchor": null
734
+ },
735
+ {
736
+ "verbPath": "community delete",
737
+ "description": "Delete a community with full cascade cleanup (all apps, KBs, vectors, GCS)",
738
+ "arguments": [],
739
+ "options": [
740
+ {
741
+ "flags": "-n, --name <community_id>",
742
+ "description": "Community ID to delete",
743
+ "required": true
744
+ },
745
+ {
746
+ "flags": "--dry-run",
747
+ "description": "Preview what would be deleted without executing",
748
+ "required": false
749
+ },
750
+ {
751
+ "flags": "--soft",
752
+ "description": "Soft delete only (mark as hidden, no cascade)",
753
+ "required": false
754
+ },
755
+ {
756
+ "flags": "--yes",
757
+ "description": "Skip confirmation prompt",
758
+ "required": false
759
+ }
760
+ ],
761
+ "runbookAnchor": null
762
+ },
763
+ {
764
+ "verbPath": "community deploy-token",
765
+ "description": "Deploy a new token contract (without creating a community)",
766
+ "arguments": [],
767
+ "options": [
768
+ {
769
+ "flags": "-t, --token <symbol>",
770
+ "description": "Token symbol (e.g., POWCH)",
771
+ "required": true
772
+ },
773
+ {
774
+ "flags": "-n, --name <name>",
775
+ "description": "Token name (e.g., \"Powch Token\")",
776
+ "required": true
777
+ },
778
+ {
779
+ "flags": "--treasury <address>",
780
+ "description": "Treasury wallet address (defaults to platform wallet)",
781
+ "required": false
782
+ },
783
+ {
784
+ "flags": "-c, --community <id>",
785
+ "description": "Community ID to link the token to (optional)",
786
+ "required": false
787
+ }
788
+ ],
789
+ "runbookAnchor": null
790
+ },
791
+ {
792
+ "verbPath": "community info",
793
+ "description": "Get community information",
794
+ "arguments": [],
795
+ "options": [
796
+ {
797
+ "flags": "-c, --community <id>",
798
+ "description": "Community ID",
799
+ "required": false
800
+ },
801
+ {
802
+ "flags": "-n, --name <id>",
803
+ "description": "Community ID (alias for -c)",
804
+ "required": false
805
+ }
806
+ ],
807
+ "runbookAnchor": null
808
+ },
809
+ {
810
+ "verbPath": "community link-token",
811
+ "description": "Link an existing token contract to a community",
812
+ "arguments": [],
813
+ "options": [
814
+ {
815
+ "flags": "-c, --community <id>",
816
+ "description": "Community ID to link to",
817
+ "required": true
818
+ },
819
+ {
820
+ "flags": "-a, --address <address>",
821
+ "description": "Contract address to link",
822
+ "required": true
823
+ },
824
+ {
825
+ "flags": "-t, --token <symbol>",
826
+ "description": "Token symbol (optional, uses contract symbol if not provided)",
827
+ "required": false
828
+ }
829
+ ],
830
+ "runbookAnchor": null
831
+ },
832
+ {
833
+ "verbPath": "community list",
834
+ "description": "List all communities",
835
+ "arguments": [],
836
+ "options": [],
837
+ "runbookAnchor": null
838
+ },
839
+ {
840
+ "verbPath": "community refresh-identity",
841
+ "description": "Mirror a community's token symbol and icon from the descix-chain registry into this environment (the icon only if it serves)",
842
+ "arguments": [],
843
+ "options": [
844
+ {
845
+ "flags": "-c, --community <id>",
846
+ "description": "Community ID",
847
+ "required": true
848
+ }
849
+ ],
850
+ "runbookAnchor": null
851
+ },
852
+ {
853
+ "verbPath": "community rename",
854
+ "description": "Rename a community_id across all surfaces (Firestore, Products, Pinecone metadata, ServiceManifests, descix-chain registry). On-chain contract + token symbol are UNTOUCHED. Dry-run first.",
855
+ "arguments": [
856
+ {
857
+ "name": "old_community_id",
858
+ "required": true,
859
+ "variadic": false,
860
+ "description": "Current community_id (e.g. unkamon)"
861
+ },
862
+ {
863
+ "name": "new_community_id",
864
+ "required": true,
865
+ "variadic": false,
866
+ "description": "New canonical community_id (e.g. unk)"
867
+ }
868
+ ],
869
+ "options": [
870
+ {
871
+ "flags": "--dry-run",
872
+ "description": "Preview the full cascade plan without executing",
873
+ "required": false
874
+ },
875
+ {
876
+ "flags": "--yes",
877
+ "description": "Skip confirmation prompt",
878
+ "required": false
879
+ }
880
+ ],
881
+ "runbookAnchor": null
882
+ },
883
+ {
884
+ "verbPath": "config gateway add-repo",
885
+ "description": "List a repo whose app the gateway serves at /p/<appId> (env.gateway.appRepos[])",
886
+ "arguments": [
887
+ {
888
+ "name": "repo",
889
+ "required": true,
890
+ "variadic": false,
891
+ "description": "Repo root relative to the workspace root"
892
+ }
893
+ ],
894
+ "options": [],
895
+ "runbookAnchor": null
896
+ },
897
+ {
898
+ "verbPath": "config gateway remove-repo",
899
+ "description": "Remove a listed repo from env.gateway.appRepos[]",
900
+ "arguments": [
901
+ {
902
+ "name": "repo",
903
+ "required": true,
904
+ "variadic": false,
905
+ "description": "Repo root relative to the workspace root, as listed"
906
+ }
907
+ ],
908
+ "options": [],
909
+ "runbookAnchor": null
910
+ },
911
+ {
912
+ "verbPath": "config gateway set-shell",
913
+ "description": "Set the repo whose app the gateway serves at / (env.gateway.shell)",
914
+ "arguments": [
915
+ {
916
+ "name": "repo",
917
+ "required": true,
918
+ "variadic": false,
919
+ "description": "Repo root relative to the workspace root, or \"none\" to remove"
920
+ }
921
+ ],
922
+ "options": [],
923
+ "runbookAnchor": null
924
+ },
925
+ {
926
+ "verbPath": "config init",
927
+ "description": "Pin this workspace to an environment (requires the global --env dev|demo|prod)",
928
+ "arguments": [],
929
+ "options": [
930
+ {
931
+ "flags": "--url <url>",
932
+ "description": "Explicit origin (for a self-hosted or port-forwarded gateway)",
933
+ "required": false
934
+ },
935
+ {
936
+ "flags": "-g, --global",
937
+ "description": "Save to global config (~/.descixrc)",
938
+ "required": false
939
+ }
940
+ ],
941
+ "runbookAnchor": "#_3-pin-production-then-sign-in"
942
+ },
943
+ {
944
+ "verbPath": "config set-dev-certs",
945
+ "description": "Point local dev servers at your own TLS cert pair (env.devCerts) — the gateway AND every app behind it",
946
+ "arguments": [],
947
+ "options": [
948
+ {
949
+ "flags": "-d, --dir <path>",
950
+ "description": "Directory holding cert.pem + key.pem",
951
+ "required": false
952
+ },
953
+ {
954
+ "flags": "-c, --cert <path>",
955
+ "description": "Certificate file",
956
+ "required": false
957
+ },
958
+ {
959
+ "flags": "-k, --key <path>",
960
+ "description": "Private key file",
961
+ "required": false
962
+ },
963
+ {
964
+ "flags": "--clear",
965
+ "description": "Remove the setting and fall back to the SDK-tracked SAN pair",
966
+ "required": false
967
+ }
968
+ ],
969
+ "runbookAnchor": null
970
+ },
971
+ {
972
+ "verbPath": "config set-env",
973
+ "description": "Set target environment persistently (updates workspace.json, auto-reconnects)",
974
+ "arguments": [
975
+ {
976
+ "name": "env",
977
+ "required": true,
978
+ "variadic": false,
979
+ "description": "Environment: dev, demo, prod, or custom name"
980
+ }
981
+ ],
982
+ "options": [
983
+ {
984
+ "flags": "-u, --url <url>",
985
+ "description": "API URL override (for custom environments)",
986
+ "required": false
987
+ }
988
+ ],
989
+ "runbookAnchor": null
990
+ },
991
+ {
992
+ "verbPath": "config set-gateway-port",
993
+ "description": "Set the port `descix serve` listens on (env.gateway.port)",
994
+ "arguments": [
995
+ {
996
+ "name": "port",
997
+ "required": true,
998
+ "variadic": false,
999
+ "description": "Port number 1-65535, or \"none\" to remove"
1000
+ }
1001
+ ],
1002
+ "options": [],
1003
+ "runbookAnchor": null
1004
+ },
1005
+ {
1006
+ "verbPath": "config set-powch-url",
1007
+ "description": "Set where Powch lives (env.powchUrl) — its OWN origin; Powch is cross-origin from the shell by design",
1008
+ "arguments": [
1009
+ {
1010
+ "name": "url",
1011
+ "required": true,
1012
+ "variadic": false,
1013
+ "description": "Powch origin (e.g. https://powch.dev.descix.net), or \"none\" to remove"
1014
+ }
1015
+ ],
1016
+ "options": [],
1017
+ "runbookAnchor": null
1018
+ },
1019
+ {
1020
+ "verbPath": "config set-site-url",
1021
+ "description": "Set the App Shell origin `descix serve` proxies / to (env.siteUrl)",
1022
+ "arguments": [
1023
+ {
1024
+ "name": "url",
1025
+ "required": true,
1026
+ "variadic": false,
1027
+ "description": "App Shell origin, or \"none\" to remove"
1028
+ }
1029
+ ],
1030
+ "options": [],
1031
+ "runbookAnchor": null
1032
+ },
1033
+ {
1034
+ "verbPath": "config show",
1035
+ "description": "Show current configuration",
1036
+ "arguments": [],
1037
+ "options": [],
1038
+ "runbookAnchor": "#_3-pin-production-then-sign-in"
1039
+ },
1040
+ {
1041
+ "verbPath": "credits balance",
1042
+ "description": "Show your AI-credits balance",
1043
+ "arguments": [],
1044
+ "options": [],
1045
+ "runbookAnchor": null
1046
+ },
1047
+ {
1048
+ "verbPath": "credits buy",
1049
+ "description": "Buy AI credits with USD (Stripe checkout)",
1050
+ "arguments": [],
1051
+ "options": [
1052
+ {
1053
+ "flags": "--usd <amount>",
1054
+ "description": "USD amount of credits to buy",
1055
+ "required": true
1056
+ },
1057
+ {
1058
+ "flags": "--return-base <url>",
1059
+ "description": "Base URL for the checkout success/cancel landing (default: the API origin in use)",
1060
+ "required": false
1061
+ }
1062
+ ],
1063
+ "runbookAnchor": null
1064
+ },
1065
+ {
1066
+ "verbPath": "credits grant",
1067
+ "description": "Grant AI credits to a user",
1068
+ "arguments": [],
1069
+ "options": [
1070
+ {
1071
+ "flags": "--user <user_id>",
1072
+ "description": "Target user id",
1073
+ "required": true
1074
+ },
1075
+ {
1076
+ "flags": "--usd <amount>",
1077
+ "description": "USD amount to grant",
1078
+ "required": true
1079
+ },
1080
+ {
1081
+ "flags": "--reason <text>",
1082
+ "description": "Audit reason",
1083
+ "required": true
1084
+ }
1085
+ ],
1086
+ "runbookAnchor": null
1087
+ },
1088
+ {
1089
+ "verbPath": "credits history",
1090
+ "description": "Show your credit ledger (purchases, debits, grants)",
1091
+ "arguments": [],
1092
+ "options": [
1093
+ {
1094
+ "flags": "--limit <n>",
1095
+ "description": "Max entries (default 50)",
1096
+ "required": false
1097
+ }
1098
+ ],
1099
+ "runbookAnchor": null
1100
+ },
1101
+ {
1102
+ "verbPath": "credits refund",
1103
+ "description": "Remove AI credits from a user (e.g. after a Stripe refund)",
1104
+ "arguments": [],
1105
+ "options": [
1106
+ {
1107
+ "flags": "--user <user_id>",
1108
+ "description": "Target user id",
1109
+ "required": true
1110
+ },
1111
+ {
1112
+ "flags": "--usd <amount>",
1113
+ "description": "USD amount to remove",
1114
+ "required": true
1115
+ },
1116
+ {
1117
+ "flags": "--reason <text>",
1118
+ "description": "Audit reason",
1119
+ "required": true
1120
+ }
1121
+ ],
1122
+ "runbookAnchor": null
1123
+ },
1124
+ {
1125
+ "verbPath": "dev-certs check",
1126
+ "description": "Check whether the dev-server cert is trusted for https://localhost (exit 0 only when trusted)",
1127
+ "arguments": [],
1128
+ "options": [
1129
+ {
1130
+ "flags": "--json",
1131
+ "description": "Output raw JSON",
1132
+ "required": false
1133
+ }
1134
+ ],
1135
+ "runbookAnchor": "#_5-run-it-locally-descix-serve"
1136
+ },
1137
+ {
1138
+ "verbPath": "dev-certs trust",
1139
+ "description": "Trust the dev-server cert in the macOS keychain (prompts for your password)",
1140
+ "arguments": [],
1141
+ "options": [],
1142
+ "runbookAnchor": "#_5-run-it-locally-descix-serve"
1143
+ },
1144
+ {
1145
+ "verbPath": "doctor",
1146
+ "description": "Diagnose environment issues (Node, Auth, gcloud, ADC)",
1147
+ "arguments": [],
1148
+ "options": [],
1149
+ "runbookAnchor": "#_3-pin-production-then-sign-in"
1150
+ },
1151
+ {
1152
+ "verbPath": "drive pull",
1153
+ "description": "Pull content from Drive and convert to local markdown",
1154
+ "arguments": [],
1155
+ "options": [
1156
+ {
1157
+ "flags": "-c, --community <id>",
1158
+ "description": "Community ID",
1159
+ "required": false
1160
+ },
1161
+ {
1162
+ "flags": "-a, --app <id>",
1163
+ "description": "App ID",
1164
+ "required": false
1165
+ },
1166
+ {
1167
+ "flags": "-k, --kb <id>",
1168
+ "description": "Knowledge Base ID (default: General)",
1169
+ "required": false
1170
+ },
1171
+ {
1172
+ "flags": "--folder <id_or_url>",
1173
+ "description": "Override Drive folder (raw ID or full Drive URL) — one-time import without modifying workspace.json",
1174
+ "required": false
1175
+ },
1176
+ {
1177
+ "flags": "-v, --verbose",
1178
+ "description": "Show verbose output",
1179
+ "required": false
1180
+ },
1181
+ {
1182
+ "flags": "--merge-mode <mode>",
1183
+ "description": "Merge mode: merge|overwrite|force-overwrite (default: merge)",
1184
+ "required": false
1185
+ },
1186
+ {
1187
+ "flags": "--dry-run",
1188
+ "description": "Show what would happen without making changes",
1189
+ "required": false
1190
+ }
1191
+ ],
1192
+ "runbookAnchor": null
1193
+ },
1194
+ {
1195
+ "verbPath": "drive push",
1196
+ "description": "Push staging files to Drive",
1197
+ "arguments": [],
1198
+ "options": [
1199
+ {
1200
+ "flags": "-c, --community <id>",
1201
+ "description": "Community ID",
1202
+ "required": false
1203
+ },
1204
+ {
1205
+ "flags": "-a, --app <id>",
1206
+ "description": "App ID",
1207
+ "required": false
1208
+ },
1209
+ {
1210
+ "flags": "-k, --kb <id>",
1211
+ "description": "Knowledge Base ID (default: General)",
1212
+ "required": false
1213
+ },
1214
+ {
1215
+ "flags": "-v, --verbose",
1216
+ "description": "Show verbose output",
1217
+ "required": false
1218
+ },
1219
+ {
1220
+ "flags": "-i, --interactive",
1221
+ "description": "Enable interactive prompts for conflicts",
1222
+ "required": false
1223
+ },
1224
+ {
1225
+ "flags": "--on-conflict <action>",
1226
+ "description": "Conflict handling: overwrite|skip (default: overwrite)",
1227
+ "required": false
1228
+ },
1229
+ {
1230
+ "flags": "--no-move",
1231
+ "description": "Do not move files to .processed after upload",
1232
+ "required": false
1233
+ },
1234
+ {
1235
+ "flags": "--dry-run",
1236
+ "description": "Show what would happen without making changes",
1237
+ "required": false
1238
+ }
1239
+ ],
1240
+ "runbookAnchor": null
1241
+ },
1242
+ {
1243
+ "verbPath": "health",
1244
+ "description": "Check platform service health (env-aware: local-port in DEV, gcloud+HTTPS in DEMO/PROD)",
1245
+ "arguments": [],
1246
+ "options": [
1247
+ {
1248
+ "flags": "--env <name>",
1249
+ "description": "Target environment: dev|demo|prod (default: dev). Also accepted at top level: descix --env=demo health ...",
1250
+ "required": false
1251
+ },
1252
+ {
1253
+ "flags": "-m, --microservice <name>",
1254
+ "description": "Check a specific service/app by appId",
1255
+ "required": false
1256
+ },
1257
+ {
1258
+ "flags": "-j, --json",
1259
+ "description": "Output raw JSON",
1260
+ "required": false
1261
+ }
1262
+ ],
1263
+ "runbookAnchor": null
1264
+ },
1265
+ {
1266
+ "verbPath": "init",
1267
+ "description": "Initialize workspace for DeSciX app development (Git-aware)",
1268
+ "arguments": [],
1269
+ "options": [
1270
+ {
1271
+ "flags": "-c, --community <id>",
1272
+ "description": "Community ID",
1273
+ "required": false
1274
+ },
1275
+ {
1276
+ "flags": "-a, --app <name>",
1277
+ "description": "App name",
1278
+ "required": false
1279
+ },
1280
+ {
1281
+ "flags": "-p, --path <path>",
1282
+ "description": "Project path (defaults to current directory)",
1283
+ "required": false
1284
+ },
1285
+ {
1286
+ "flags": "-f, --force",
1287
+ "description": "Restart the app registrations in an existing workspace (its environment settings are kept)",
1288
+ "required": false
1289
+ },
1290
+ {
1291
+ "flags": "-y, --yes",
1292
+ "description": "Skip the confirmation — with -c and -a, init runs without a terminal",
1293
+ "required": false
1294
+ },
1295
+ {
1296
+ "flags": "--from-invite <token>",
1297
+ "description": "Resolve an invite token to pre-fill app context",
1298
+ "required": false
1299
+ }
1300
+ ],
1301
+ "runbookAnchor": null
1302
+ },
1303
+ {
1304
+ "verbPath": "kb clear-override-model",
1305
+ "description": "Delete KB.kb_model_override via FieldValue.delete() (resets to App.default_app_model inheritance)",
1306
+ "arguments": [],
1307
+ "options": [
1308
+ {
1309
+ "flags": "-a, --app <app_id>",
1310
+ "description": "App ID",
1311
+ "required": true
1312
+ },
1313
+ {
1314
+ "flags": "-k, --kb <kb_name>",
1315
+ "description": "KB name",
1316
+ "required": true
1317
+ }
1318
+ ],
1319
+ "runbookAnchor": null
1320
+ },
1321
+ {
1322
+ "verbPath": "kb corpus status",
1323
+ "description": "Show corpus sync state (files, chunks, last sync, resolved ref)",
1324
+ "arguments": [],
1325
+ "options": [
1326
+ {
1327
+ "flags": "-a, --app <id>",
1328
+ "description": "App ID",
1329
+ "required": true
1330
+ },
1331
+ {
1332
+ "flags": "-k, --kb <name>",
1333
+ "description": "KB name (default: all)",
1334
+ "required": false
1335
+ },
1336
+ {
1337
+ "flags": "--ref <ref>",
1338
+ "description": "Preview status as if --ref were applied to a sync (does not change manifests)",
1339
+ "required": false
1340
+ },
1341
+ {
1342
+ "flags": "-v, --verbose",
1343
+ "description": "Show verbose output including change detection",
1344
+ "required": false
1345
+ }
1346
+ ],
1347
+ "runbookAnchor": "#_6-knowledge-bases"
1348
+ },
1349
+ {
1350
+ "verbPath": "kb corpus sync",
1351
+ "description": "Sync the files a corpus manifest names into the app's knowledge base",
1352
+ "arguments": [],
1353
+ "options": [
1354
+ {
1355
+ "flags": "-a, --app <id>",
1356
+ "description": "App ID",
1357
+ "required": true
1358
+ },
1359
+ {
1360
+ "flags": "-c, --community <community_id>",
1361
+ "description": "Community ID (optional; resolved from Products when omitted)",
1362
+ "required": false
1363
+ },
1364
+ {
1365
+ "flags": "-k, --kb <name>",
1366
+ "description": "KB name (syncs specific manifest; default: all)",
1367
+ "required": false
1368
+ },
1369
+ {
1370
+ "flags": "-v, --verbose",
1371
+ "description": "Show verbose output",
1372
+ "required": false
1373
+ },
1374
+ {
1375
+ "flags": "--ref <ref>",
1376
+ "description": "Override the git ref for ALL manifest sources (e.g., --ref my-feature-branch). Precedence: --ref > manifest source.ref > \"main\".",
1377
+ "required": false
1378
+ },
1379
+ {
1380
+ "flags": "--rebuild",
1381
+ "description": "Delete EVERYTHING in the knowledge base, then re-sync the whole corpus. Not needed to remove deleted or changed files — an ordinary sync already removes any corpus file that is live in the knowledge base but no longer in the corpus (see --dry-run, which names them). Use --rebuild only to clear content an ordinary sync cannot see. Prompts before deleting unless --yes is supplied.",
1382
+ "required": false
1383
+ },
1384
+ {
1385
+ "flags": "--dry-run",
1386
+ "description": "Show what a sync would add and remove — naming each file it would remove — without changing anything. Exit 0 if nothing would change, 1 if something would.",
1387
+ "required": false
1388
+ },
1389
+ {
1390
+ "flags": "--show-walk",
1391
+ "description": "Print the resolved ref and the first 50 files the manifest selects, before syncing anything. Useful for checking --ref and the manifest sources.",
1392
+ "required": false
1393
+ },
1394
+ {
1395
+ "flags": "--yes",
1396
+ "description": "Skip the interactive purge confirmation in --rebuild mode. Use in scripting/CI.",
1397
+ "required": false
1398
+ },
1399
+ {
1400
+ "flags": "--skip-retrieval-canary",
1401
+ "description": "Skip the post-sync check that a synced passage is actually searchable (a large sync can take several minutes to become searchable). Skipping saves one credit-metered query and up to ~25 s; the sync then reports success on upload alone. Leave the check on for anything user-facing.",
1402
+ "required": false
1403
+ }
1404
+ ],
1405
+ "runbookAnchor": "#_6-knowledge-bases"
1406
+ },
1407
+ {
1408
+ "verbPath": "kb delete",
1409
+ "description": "Delete a knowledge base registry doc (refuses a non-empty KB unless --force)",
1410
+ "arguments": [],
1411
+ "options": [
1412
+ {
1413
+ "flags": "-a, --app <app_id>",
1414
+ "description": "App ID",
1415
+ "required": true
1416
+ },
1417
+ {
1418
+ "flags": "-k, --kb <kb_name>",
1419
+ "description": "KB name",
1420
+ "required": true
1421
+ },
1422
+ {
1423
+ "flags": "--force",
1424
+ "description": "Purge the KB's live vectors and delete it even if non-empty. An empty KB deletes without this flag.",
1425
+ "required": false
1426
+ }
1427
+ ],
1428
+ "runbookAnchor": null
1429
+ },
1430
+ {
1431
+ "verbPath": "kb doctor",
1432
+ "description": "Check a KB against its last sync by FILE IDENTITY: live corpus files that were not walked (orphans) and walked files that are not live (missing)",
1433
+ "arguments": [],
1434
+ "options": [
1435
+ {
1436
+ "flags": "-a, --app <id>",
1437
+ "description": "App ID",
1438
+ "required": true
1439
+ },
1440
+ {
1441
+ "flags": "-k, --kb <name>",
1442
+ "description": "KB name",
1443
+ "required": true
1444
+ },
1445
+ {
1446
+ "flags": "--live",
1447
+ "description": "Compute vectorCount from the TRUE live Pinecone scope (bypass the cached counter, which lies after an interrupted op)",
1448
+ "required": false
1449
+ },
1450
+ {
1451
+ "flags": "--reconcile",
1452
+ "description": "Compute the live count AND write it back to rag_vector_count so the cached read is truthful again (implies --live)",
1453
+ "required": false
1454
+ }
1455
+ ],
1456
+ "runbookAnchor": null
1457
+ },
1458
+ {
1459
+ "verbPath": "kb list",
1460
+ "description": "List knowledge bases for an app",
1461
+ "arguments": [],
1462
+ "options": [
1463
+ {
1464
+ "flags": "-a, --app <app_id>",
1465
+ "description": "App ID",
1466
+ "required": true
1467
+ },
1468
+ {
1469
+ "flags": "--cached",
1470
+ "description": "Show the fast cached vector counter instead of the TRUE live Pinecone count. The cached counter is written ONLY by the CLI/PWA sync path, so it reports 0 for KBs ingested by any other route even when their vectors retrieve. Default is the live count.",
1471
+ "required": false
1472
+ }
1473
+ ],
1474
+ "runbookAnchor": "#_6-knowledge-bases"
1475
+ },
1476
+ {
1477
+ "verbPath": "kb set-override-model",
1478
+ "description": "Set KB.kb_model_override (per-KB model selection)",
1479
+ "arguments": [],
1480
+ "options": [
1481
+ {
1482
+ "flags": "-a, --app <app_id>",
1483
+ "description": "App ID",
1484
+ "required": true
1485
+ },
1486
+ {
1487
+ "flags": "-k, --kb <kb_name>",
1488
+ "description": "KB name",
1489
+ "required": true
1490
+ },
1491
+ {
1492
+ "flags": "-m, --model <model_name>",
1493
+ "description": "Model name (e.g. gemini-3.8-flash)",
1494
+ "required": true
1495
+ }
1496
+ ],
1497
+ "runbookAnchor": null
1498
+ },
1499
+ {
1500
+ "verbPath": "login",
1501
+ "description": "Authenticate with DeSciX via device login (opens browser)",
1502
+ "arguments": [],
1503
+ "options": [
1504
+ {
1505
+ "flags": "-u, --url <url>",
1506
+ "description": "API URL override",
1507
+ "required": false
1508
+ },
1509
+ {
1510
+ "flags": "--wallet",
1511
+ "description": "Use direct wallet connection (advanced, not yet implemented)",
1512
+ "required": false
1513
+ },
1514
+ {
1515
+ "flags": "--no-oauth",
1516
+ "description": "Skip the OAuth long-lived token leg (wallet-signature login only)",
1517
+ "required": false
1518
+ },
1519
+ {
1520
+ "flags": "--scope <scope>",
1521
+ "description": "OAuth scope to request (default: mcp:read mcp:tools mcp:write mcp:admin)",
1522
+ "required": false
1523
+ }
1524
+ ],
1525
+ "runbookAnchor": "#_3-pin-production-then-sign-in"
1526
+ },
1527
+ {
1528
+ "verbPath": "logout",
1529
+ "description": "Clear saved credentials",
1530
+ "arguments": [],
1531
+ "options": [],
1532
+ "runbookAnchor": "#_3-pin-production-then-sign-in"
1533
+ },
1534
+ {
1535
+ "verbPath": "mcp execute",
1536
+ "description": "Execute a registered MCP tool by name with JSON parameters",
1537
+ "arguments": [],
1538
+ "options": [
1539
+ {
1540
+ "flags": "--tool <name>",
1541
+ "description": "Tool/command name (e.g., find_communities, ask_question_to_app)",
1542
+ "required": true
1543
+ },
1544
+ {
1545
+ "flags": "--params <json>",
1546
+ "description": "JSON parameters for the tool",
1547
+ "required": false
1548
+ },
1549
+ {
1550
+ "flags": "-a, --app <app_id>",
1551
+ "description": "App context (sets app_id in params if not already present)",
1552
+ "required": false
1553
+ },
1554
+ {
1555
+ "flags": "--json",
1556
+ "description": "Output raw JSON response",
1557
+ "required": false
1558
+ }
1559
+ ],
1560
+ "runbookAnchor": null
1561
+ },
1562
+ {
1563
+ "verbPath": "mcp-serve",
1564
+ "description": "Start MCP server for Cursor/VS Code integration (used by npx)",
1565
+ "arguments": [],
1566
+ "options": [],
1567
+ "runbookAnchor": null
1568
+ },
1569
+ {
1570
+ "verbPath": "microservice health",
1571
+ "description": "Check health of a registered microservice",
1572
+ "arguments": [
1573
+ {
1574
+ "name": "name",
1575
+ "required": true,
1576
+ "variadic": false,
1577
+ "description": ""
1578
+ }
1579
+ ],
1580
+ "options": [],
1581
+ "runbookAnchor": null
1582
+ },
1583
+ {
1584
+ "verbPath": "microservice init",
1585
+ "description": "Initialize microservice scaffold in current app",
1586
+ "arguments": [],
1587
+ "options": [
1588
+ {
1589
+ "flags": "-f, --force",
1590
+ "description": "Overwrite existing microservice/ folder",
1591
+ "required": false
1592
+ },
1593
+ {
1594
+ "flags": "-c, --community <id>",
1595
+ "description": "Community ID (auto-detects from context)",
1596
+ "required": false
1597
+ },
1598
+ {
1599
+ "flags": "-a, --app <id>",
1600
+ "description": "App ID (auto-detects from context)",
1601
+ "required": false
1602
+ }
1603
+ ],
1604
+ "runbookAnchor": null
1605
+ },
1606
+ {
1607
+ "verbPath": "microservice list",
1608
+ "description": "List all registered microservices",
1609
+ "arguments": [],
1610
+ "options": [],
1611
+ "runbookAnchor": null
1612
+ },
1613
+ {
1614
+ "verbPath": "microservice register",
1615
+ "description": "Register microservice with gateway (-r <local SERVICE_README>; git-mode only — no Drive)",
1616
+ "arguments": [],
1617
+ "options": [
1618
+ {
1619
+ "flags": "-m, --manifest <path>",
1620
+ "description": "Path to manifest.json",
1621
+ "required": false
1622
+ },
1623
+ {
1624
+ "flags": "-r, --readme <path>",
1625
+ "description": "Path to local SERVICE_README file",
1626
+ "required": false
1627
+ },
1628
+ {
1629
+ "flags": "-c, --community <id>",
1630
+ "description": "Community ID (auto-detects from context)",
1631
+ "required": false
1632
+ },
1633
+ {
1634
+ "flags": "-a, --app <id>",
1635
+ "description": "App ID (auto-detects from context)",
1636
+ "required": false
1637
+ },
1638
+ {
1639
+ "flags": "--skip-readme-check",
1640
+ "description": "Skip SERVICE_README check (not recommended)",
1641
+ "required": false
1642
+ }
1643
+ ],
1644
+ "runbookAnchor": null
1645
+ },
1646
+ {
1647
+ "verbPath": "microservice reload",
1648
+ "description": "Reload microservice manifests",
1649
+ "arguments": [],
1650
+ "options": [],
1651
+ "runbookAnchor": null
1652
+ },
1653
+ {
1654
+ "verbPath": "microservice restart",
1655
+ "description": "Restart a local microservice (DEV only; DEMO/PROD use deploy scripts)",
1656
+ "arguments": [
1657
+ {
1658
+ "name": "name",
1659
+ "required": true,
1660
+ "variadic": false,
1661
+ "description": ""
1662
+ }
1663
+ ],
1664
+ "options": [
1665
+ {
1666
+ "flags": "--env <env>",
1667
+ "description": "Target environment: dev | demo | prod",
1668
+ "required": false
1669
+ }
1670
+ ],
1671
+ "runbookAnchor": null
1672
+ },
1673
+ {
1674
+ "verbPath": "microservice vectorize",
1675
+ "description": "Vectorize SERVICE_README for tell_me_how discovery",
1676
+ "arguments": [],
1677
+ "options": [
1678
+ {
1679
+ "flags": "-n, --name <name>",
1680
+ "description": "Service name (reads from manifest.json if not provided)",
1681
+ "required": false
1682
+ },
1683
+ {
1684
+ "flags": "-c, --community <id>",
1685
+ "description": "Community ID (auto-detects from context)",
1686
+ "required": false
1687
+ },
1688
+ {
1689
+ "flags": "-a, --app <id>",
1690
+ "description": "App ID (auto-detects from context)",
1691
+ "required": false
1692
+ },
1693
+ {
1694
+ "flags": "-r, --readme <path>",
1695
+ "description": "Path to SERVICE_README file",
1696
+ "required": false
1697
+ }
1698
+ ],
1699
+ "runbookAnchor": null
1700
+ },
1701
+ {
1702
+ "verbPath": "new-chat",
1703
+ "description": "Clear chat session for an app (start fresh conversation)",
1704
+ "arguments": [],
1705
+ "options": [
1706
+ {
1707
+ "flags": "-c, --community <id>",
1708
+ "description": "Community ID (optional; clears only that community key)",
1709
+ "required": false
1710
+ },
1711
+ {
1712
+ "flags": "-a, --app <id>",
1713
+ "description": "App ID (required)",
1714
+ "required": false
1715
+ }
1716
+ ],
1717
+ "runbookAnchor": null
1718
+ },
1719
+ {
1720
+ "verbPath": "purchases",
1721
+ "description": "List your purchased communities and apps",
1722
+ "arguments": [],
1723
+ "options": [],
1724
+ "runbookAnchor": null
1725
+ },
1726
+ {
1727
+ "verbPath": "quickstart",
1728
+ "description": "One-command setup: sign in → workspace → app (with -c and -a) → agent files → MCP config",
1729
+ "arguments": [],
1730
+ "options": [
1731
+ {
1732
+ "flags": "-u, --url <url>",
1733
+ "description": "API URL override",
1734
+ "required": false
1735
+ },
1736
+ {
1737
+ "flags": "-c, --community <id>",
1738
+ "description": "Community to create the app in",
1739
+ "required": false
1740
+ },
1741
+ {
1742
+ "flags": "-a, --app <name>",
1743
+ "description": "Name of the app to create (the platform issues its id; see app init)",
1744
+ "required": false
1745
+ },
1746
+ {
1747
+ "flags": "-y, --yes",
1748
+ "description": "Skip the confirmation — with -c and -a, quickstart runs without a terminal",
1749
+ "required": false
1750
+ }
1751
+ ],
1752
+ "runbookAnchor": null
1753
+ },
1754
+ {
1755
+ "verbPath": "reconnect",
1756
+ "description": "Reconnect using saved wallet credentials",
1757
+ "arguments": [],
1758
+ "options": [],
1759
+ "runbookAnchor": null
1760
+ },
1761
+ {
1762
+ "verbPath": "referral create",
1763
+ "description": "Generate a referral code for a community/app",
1764
+ "arguments": [],
1765
+ "options": [
1766
+ {
1767
+ "flags": "-c, --community <id>",
1768
+ "description": "Community ID",
1769
+ "required": true
1770
+ },
1771
+ {
1772
+ "flags": "-a, --app <id>",
1773
+ "description": "App ID (optional)",
1774
+ "required": false
1775
+ }
1776
+ ],
1777
+ "runbookAnchor": null
1778
+ },
1779
+ {
1780
+ "verbPath": "role create",
1781
+ "description": "Create a new role",
1782
+ "arguments": [],
1783
+ "options": [
1784
+ {
1785
+ "flags": "--scope <scope>",
1786
+ "description": "Scope: PLATFORM, COMMUNITY, or APP",
1787
+ "required": true
1788
+ },
1789
+ {
1790
+ "flags": "--scope-id <id>",
1791
+ "description": "Scope ID (community_id or app_id)",
1792
+ "required": true
1793
+ },
1794
+ {
1795
+ "flags": "--role-id <id>",
1796
+ "description": "Role ID (e.g., \"member\", \"admin\")",
1797
+ "required": true
1798
+ },
1799
+ {
1800
+ "flags": "--name <name>",
1801
+ "description": "Role display name",
1802
+ "required": true
1803
+ },
1804
+ {
1805
+ "flags": "--description <text>",
1806
+ "description": "Role description",
1807
+ "required": false
1808
+ },
1809
+ {
1810
+ "flags": "--price-usdsci <amount>",
1811
+ "description": "Price in USDCX (default: 0 = free)",
1812
+ "required": false
1813
+ }
1814
+ ],
1815
+ "runbookAnchor": null
1816
+ },
1817
+ {
1818
+ "verbPath": "serve",
1819
+ "description": "Start the unified local gateway (one HTTPS origin: App Shell at /, your app at /p/<app>, /apifront to the API)",
1820
+ "arguments": [],
1821
+ "options": [
1822
+ {
1823
+ "flags": "-p, --port <port>",
1824
+ "description": "Gateway port for this run (default: env.gateway.port, else 5173)",
1825
+ "required": false
1826
+ },
1827
+ {
1828
+ "flags": "-w, --workspace <path>",
1829
+ "description": "Workspace root override",
1830
+ "required": false
1831
+ },
1832
+ {
1833
+ "flags": "--site-url <url>",
1834
+ "description": "App Shell target for this run (default: env.siteUrl, a local platform site, else the API origin)",
1835
+ "required": false
1836
+ },
1837
+ {
1838
+ "flags": "-a, --app <id>",
1839
+ "description": "App to serve standalone (default: detected from the directory you are standing in)",
1840
+ "required": false
1841
+ }
1842
+ ],
1843
+ "runbookAnchor": "#_5-run-it-locally-descix-serve"
1844
+ },
1845
+ {
1846
+ "verbPath": "site delete",
1847
+ "description": "Delete deployed site",
1848
+ "arguments": [],
1849
+ "options": [
1850
+ {
1851
+ "flags": "-c, --community <id>",
1852
+ "description": "Community ID (auto-detects from context)",
1853
+ "required": false
1854
+ },
1855
+ {
1856
+ "flags": "-a, --app <id>",
1857
+ "description": "App ID (auto-detects from context)",
1858
+ "required": false
1859
+ },
1860
+ {
1861
+ "flags": "--preview",
1862
+ "description": "Delete preview site only",
1863
+ "required": false
1864
+ },
1865
+ {
1866
+ "flags": "--confirm",
1867
+ "description": "Skip confirmation prompt",
1868
+ "required": false
1869
+ }
1870
+ ],
1871
+ "runbookAnchor": null
1872
+ },
1873
+ {
1874
+ "verbPath": "site init",
1875
+ "description": "Initialize site scaffold in current app",
1876
+ "arguments": [],
1877
+ "options": [
1878
+ {
1879
+ "flags": "-f, --force",
1880
+ "description": "Overwrite existing site/ folder",
1881
+ "required": false
1882
+ },
1883
+ {
1884
+ "flags": "-c, --community <id>",
1885
+ "description": "Community ID (auto-detects from context)",
1886
+ "required": false
1887
+ },
1888
+ {
1889
+ "flags": "-a, --app <id>",
1890
+ "description": "App ID (auto-detects from context)",
1891
+ "required": false
1892
+ }
1893
+ ],
1894
+ "runbookAnchor": null
1895
+ },
1896
+ {
1897
+ "verbPath": "site list",
1898
+ "description": "List deployed site files",
1899
+ "arguments": [],
1900
+ "options": [
1901
+ {
1902
+ "flags": "-c, --community <id>",
1903
+ "description": "Community ID (auto-detects from context)",
1904
+ "required": false
1905
+ },
1906
+ {
1907
+ "flags": "-a, --app <id>",
1908
+ "description": "App ID (auto-detects from context)",
1909
+ "required": false
1910
+ },
1911
+ {
1912
+ "flags": "--preview",
1913
+ "description": "List preview site",
1914
+ "required": false
1915
+ }
1916
+ ],
1917
+ "runbookAnchor": null
1918
+ },
1919
+ {
1920
+ "verbPath": "site status",
1921
+ "description": "Get deployment status and manifest",
1922
+ "arguments": [],
1923
+ "options": [
1924
+ {
1925
+ "flags": "-c, --community <id>",
1926
+ "description": "Community ID (auto-detects from context)",
1927
+ "required": false
1928
+ },
1929
+ {
1930
+ "flags": "-a, --app <id>",
1931
+ "description": "App ID (auto-detects from context)",
1932
+ "required": false
1933
+ },
1934
+ {
1935
+ "flags": "--preview",
1936
+ "description": "Check preview site",
1937
+ "required": false
1938
+ }
1939
+ ],
1940
+ "runbookAnchor": "#_8-deploy-the-site"
1941
+ },
1942
+ {
1943
+ "verbPath": "site upload",
1944
+ "description": "Upload site to GCS and update app metadata (uses .descix/manifests/site.json when present)",
1945
+ "arguments": [],
1946
+ "options": [
1947
+ {
1948
+ "flags": "-c, --community <id>",
1949
+ "description": "Community ID (auto-detects from context)",
1950
+ "required": false
1951
+ },
1952
+ {
1953
+ "flags": "-a, --app <id>",
1954
+ "description": "App ID (auto-detects from context)",
1955
+ "required": false
1956
+ },
1957
+ {
1958
+ "flags": "-p, --path <localPath>",
1959
+ "description": "Local directory to deploy (ignored when site manifest exists)",
1960
+ "required": false
1961
+ },
1962
+ {
1963
+ "flags": "--preview",
1964
+ "description": "Deploy to preview path",
1965
+ "required": false
1966
+ },
1967
+ {
1968
+ "flags": "--dry-run",
1969
+ "description": "Show what would be uploaded and which server files would be removed",
1970
+ "required": false
1971
+ },
1972
+ {
1973
+ "flags": "--no-cache",
1974
+ "description": "Set Cache-Control: no-cache",
1975
+ "required": false
1976
+ }
1977
+ ],
1978
+ "runbookAnchor": "#_8-deploy-the-site"
1979
+ },
1980
+ {
1981
+ "verbPath": "stats",
1982
+ "description": "Get user stats (REP/REF/DIP) for a community",
1983
+ "arguments": [],
1984
+ "options": [
1985
+ {
1986
+ "flags": "-c, --community <id>",
1987
+ "description": "Community ID",
1988
+ "required": true
1989
+ }
1990
+ ],
1991
+ "runbookAnchor": null
1992
+ },
1993
+ {
1994
+ "verbPath": "status",
1995
+ "description": "Show comprehensive status of developer environment",
1996
+ "arguments": [],
1997
+ "options": [],
1998
+ "runbookAnchor": null
1999
+ },
2000
+ {
2001
+ "verbPath": "store generate-summary",
2002
+ "description": "Generate AI summary for an entity",
2003
+ "arguments": [],
2004
+ "options": [
2005
+ {
2006
+ "flags": "-t, --type <type>",
2007
+ "description": "Entity type (COMMUNITY, APP, KB, IPDOC)",
2008
+ "required": true
2009
+ },
2010
+ {
2011
+ "flags": "-i, --id <id>",
2012
+ "description": "Entity ID",
2013
+ "required": true
2014
+ },
2015
+ {
2016
+ "flags": "-c, --community <id>",
2017
+ "description": "Community ID (required for APP, KB, IPDOC)",
2018
+ "required": false
2019
+ },
2020
+ {
2021
+ "flags": "-a, --app <id>",
2022
+ "description": "App ID (required for KB, IPDOC)",
2023
+ "required": false
2024
+ },
2025
+ {
2026
+ "flags": "-k, --kb <id>",
2027
+ "description": "KB ID (required for IPDOC)",
2028
+ "required": false
2029
+ }
2030
+ ],
2031
+ "runbookAnchor": null
2032
+ },
2033
+ {
2034
+ "verbPath": "store search",
2035
+ "description": "Search store catalog (communities, apps, products, documents)",
2036
+ "arguments": [],
2037
+ "options": [
2038
+ {
2039
+ "flags": "-q, --query <text>",
2040
+ "description": "Search query",
2041
+ "required": false
2042
+ },
2043
+ {
2044
+ "flags": "-t, --type <types>",
2045
+ "description": "Entity types (comma-separated: COMMUNITY,APP,KB,IPDOC,ROLE)",
2046
+ "required": false
2047
+ },
2048
+ {
2049
+ "flags": "-c, --community <id>",
2050
+ "description": "Filter by community ID",
2051
+ "required": false
2052
+ },
2053
+ {
2054
+ "flags": "-a, --app <id>",
2055
+ "description": "Filter by app ID",
2056
+ "required": false
2057
+ },
2058
+ {
2059
+ "flags": "-k, --kb <id>",
2060
+ "description": "Filter by knowledge base ID",
2061
+ "required": false
2062
+ },
2063
+ {
2064
+ "flags": "--price-min <number>",
2065
+ "description": "Minimum price filter",
2066
+ "required": false
2067
+ },
2068
+ {
2069
+ "flags": "--price-max <number>",
2070
+ "description": "Maximum price filter",
2071
+ "required": false
2072
+ },
2073
+ {
2074
+ "flags": "--tags <tags>",
2075
+ "description": "Filter by tags (comma-separated)",
2076
+ "required": false
2077
+ },
2078
+ {
2079
+ "flags": "-l, --limit <number>",
2080
+ "description": "Number of results",
2081
+ "required": false
2082
+ },
2083
+ {
2084
+ "flags": "--offset <number>",
2085
+ "description": "Pagination offset",
2086
+ "required": false
2087
+ }
2088
+ ],
2089
+ "runbookAnchor": null
2090
+ },
2091
+ {
2092
+ "verbPath": "tell-me-how",
2093
+ "description": "Discover platform tools using natural language (Intelligent MCP Mesh)",
2094
+ "arguments": [
2095
+ {
2096
+ "name": "question",
2097
+ "required": true,
2098
+ "variadic": false,
2099
+ "description": "What do you want to accomplish? Use natural language."
2100
+ }
2101
+ ],
2102
+ "options": [
2103
+ {
2104
+ "flags": "-s, --scope <scope>",
2105
+ "description": "Search scope (validated against the published tell_me_how enum): bootstrap, artifact, project, entitlements (default), discovery",
2106
+ "required": false
2107
+ },
2108
+ {
2109
+ "flags": "-j, --json",
2110
+ "description": "Output raw JSON response",
2111
+ "required": false
2112
+ }
2113
+ ],
2114
+ "runbookAnchor": "#_9-list-it-and-discover-the-rest"
2115
+ },
2116
+ {
2117
+ "verbPath": "whoami",
2118
+ "description": "Show current authentication status",
2119
+ "arguments": [],
2120
+ "options": [],
2121
+ "runbookAnchor": "#_3-pin-production-then-sign-in"
2122
+ }
2123
+ ]