@dx-do/cli 5.2.45 → 5.2.47
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 +57 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,17 +9,30 @@
|
|
|
9
9
|
:warning: Using npm install for this package is highly discouraged.
|
|
10
10
|
|
|
11
11
|
|
|
12
|
+
# via npx
|
|
13
|
+
|
|
12
14
|
```
|
|
13
15
|
npx @dx-do/cli@<version> <--config=<config-file>> command-group command <parameter>=<value>
|
|
14
16
|
```
|
|
17
|
+
# via bunx
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
bunx @dx-do/cli@<version> <--config=<config-file>> command-group command <parameter>=<value>
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
# via binary
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
dx-do <--config=<config-file>> command-group command <parameter>=<value>
|
|
27
|
+
```
|
|
15
28
|
|
|
16
29
|
#### Output
|
|
17
30
|
|
|
18
31
|
```
|
|
19
|
-
ℹ info dx-do
|
|
32
|
+
ℹ info dx-do v5.2.46 on node v22.21.0 on darwin-arm64 via node (ssl: 3.5.4)
|
|
20
33
|
⚠ warning Not loading configuration
|
|
21
34
|
✖ error Usage: dx-do --option[=value]... <command-group> <command> <command-param>=<value>...
|
|
22
|
-
ℹ info Available command-groups:
|
|
35
|
+
ℹ info Available command-groups: acc, agent, agentic, alarm, alert, apm-universe, asm, attribute, audit, auth, axa, blob, channel, config, dashboard, diagnose, event, experience, graph, help, inventory, jsextension, log, managementmodule, metrex, metric, metricgrouping, nass, o2-alert, o2-managementmodule, o2-metricgrouping, o2-universe, perspective, service, situation, sql, tas, topographer, trace, ui, vertex
|
|
23
36
|
```
|
|
24
37
|
|
|
25
38
|
|
|
@@ -325,24 +338,34 @@ npx @dx-do/cli@<version> <--config=<config-file>> command-group command <paramet
|
|
|
325
338
|
⤜ alarm-data........................................: provides the situation alarm data
|
|
326
339
|
⤜ query.............................................: finds situations
|
|
327
340
|
```
|
|
328
|
-
#### sql
|
|
329
|
-
```sql
|
|
330
|
-
⤜ examples..........................................: shows example queries
|
|
331
|
-
⤜ query.............................................: executes an APM sql query
|
|
332
|
-
⤜ date-to-timestamp.................................: converts dates to timestamps for use in queries
|
|
333
|
-
```
|
|
334
341
|
#### acc
|
|
335
342
|
```acc
|
|
343
|
+
⤜ set-bundle-property...............................: sets a property override on a bundle within a package (single PATCH)
|
|
344
|
+
⤜ package-required-bundles..........................: lists bundles required by a package (always-shipped framework set)
|
|
345
|
+
⤜ package-property-overrides........................: lists property overrides applied on top of bundle defaults for a package
|
|
336
346
|
⤜ package-details...................................: gets package details
|
|
347
|
+
⤜ package-compatible-bundles........................: lists bundles compatible with a package (candidate add-bundle set)
|
|
337
348
|
⤜ package-bundles...................................: gets package bundles
|
|
349
|
+
⤜ package-bundle-profile............................: fetches a single bundle's profile (property catalog + overrides) within a package
|
|
350
|
+
⤜ package-builder-options...........................: lists valid environment combinations for create-package (UI 'new package' wizard data)
|
|
338
351
|
⤜ list-packages.....................................: lists acc packages
|
|
339
352
|
⤜ list-bundles......................................: lists acc bundles
|
|
340
353
|
⤜ initialize-bundle-directory.......................: initialize a prepared bundle directory
|
|
341
354
|
⤜ import-packages...................................: import packages from an export file
|
|
342
355
|
⤜ import-bundle.....................................: import bundle from a bundle tar.gz file
|
|
343
356
|
⤜ export-packages...................................: exports packages to a file
|
|
357
|
+
⤜ download-package..................................: downloads a server-assembled tenant-stamped agent package tarball
|
|
344
358
|
⤜ download-bundle...................................: downloads bundle
|
|
359
|
+
⤜ delete-package....................................: deletes a package
|
|
360
|
+
⤜ create-package....................................: creates a new ACC package from typed args (UI new-package wizard equivalent)
|
|
345
361
|
⤜ bundle-details....................................: gets bundle details
|
|
362
|
+
⤜ add-package-bundles...............................: attaches bundles to a package (single PATCH, no draft/publish dance)
|
|
363
|
+
```
|
|
364
|
+
#### sql
|
|
365
|
+
```sql
|
|
366
|
+
⤜ examples..........................................: shows example queries
|
|
367
|
+
⤜ query.............................................: executes an APM sql query
|
|
368
|
+
⤜ date-to-timestamp.................................: converts dates to timestamps for use in queries
|
|
346
369
|
```
|
|
347
370
|
#### o2-metricgrouping
|
|
348
371
|
```o2-metricgrouping
|
|
@@ -427,13 +450,20 @@ npx @dx-do/cli@<version> <--config=<config-file>> command-group command <paramet
|
|
|
427
450
|
```attribute
|
|
428
451
|
⤜ dump..............................................: dumps all attributes by layer
|
|
429
452
|
```
|
|
453
|
+
#### diagnose
|
|
454
|
+
```diagnose
|
|
455
|
+
⤜ services..........................................: Audit the bound tenant's DXO2 service organization. Returns severity-tagged findings (errors / warnings / recommendations) per service. Optionally scope by serviceName (with or without descendants). [experimental]
|
|
456
|
+
⤜ explain...........................................: Explain every diagnostic rule (or filter to one scope). Pure metadata — no tenant binding required. [experimental]
|
|
457
|
+
```
|
|
430
458
|
#### audit
|
|
431
459
|
```audit
|
|
432
460
|
⤜ query.............................................: query data-store audit events
|
|
433
461
|
```
|
|
434
462
|
#### agentic
|
|
435
463
|
```agentic
|
|
464
|
+
⤜ schema............................................: Emit the canonical JSON Schema for a DataStore query payload (TAS / NASSQL / Metrics-Metadata), optionally narrowed to one op. [experimental]
|
|
436
465
|
⤜ mcp...............................................: Run a stdio MCP server for the bound tenant. Wire into Claude Code / Cursor with `claude mcp add` (or equivalent). [experimental]
|
|
466
|
+
⤜ learn-tenant......................................: Reserve the per-tenant corpus storage at ~/.dxdo/<alias>/corpus/ (no-op stub; full learning logic is forthcoming). [experimental]
|
|
437
467
|
⤜ extract-claude-marketplace........................: Extract the embedded Claude Code marketplace + plugins to disk. Writes `<base-directory>/dx-do-claude-marketplace/` containing the marketplace.json and one subdir per plugin. Prints the `/plugin` slash-command sequence to install them. [experimental]
|
|
438
468
|
⤜ corpus-sections...................................: List the sections of the dx-do catalog (queries, cookbooks, entities, …). [experimental]
|
|
439
469
|
⤜ corpus-section-index..............................: List entries in a catalog section. Each row is labelled `<section>/<id>` for copy-paste into `agentic corpus-entry`. [experimental]
|
|
@@ -473,7 +503,7 @@ npx @dx-do/cli alert list
|
|
|
473
503
|
|
|
474
504
|
***
|
|
475
505
|
|
|
476
|
-
|
|
506
|
+
## proxyConfig
|
|
477
507
|
|
|
478
508
|
```
|
|
479
509
|
--proxyConfig=<proxyConfigFilename>
|
|
@@ -495,12 +525,29 @@ npx @dx-do/cli alert list
|
|
|
495
525
|
|
|
496
526
|
***
|
|
497
527
|
|
|
498
|
-
|
|
528
|
+
### non interactive mode (suitable for running from a script)
|
|
499
529
|
|
|
500
530
|
```
|
|
501
531
|
--noninteractive
|
|
502
532
|
```
|
|
503
533
|
|
|
534
|
+
### Experimental commands
|
|
535
|
+
|
|
536
|
+
Some `dx-do` commands are marked **experimental** — they're being designed, may change shape between releases, or are only safe to run on test tenants. They're hidden from `dx-do help commands` and refused at runtime by default. Open the gate either way:
|
|
537
|
+
|
|
538
|
+
* **Per-invocation flag**: `dx-do --enable-experimental-commands <group> <command> ...`
|
|
539
|
+
* **Env var**: `export DXDO_ENABLE_EXPERIMENTAL_COMMANDS=true`
|
|
540
|
+
|
|
541
|
+
Both forms behave identically; pick whichever fits your workflow. The env var is the better choice when you need experimental commands repeatedly (CI, scripts, an MCP-server-spawn config in Claude Code / Cursor).
|
|
542
|
+
|
|
543
|
+
To see which commands are experimental, run any of:
|
|
544
|
+
|
|
545
|
+
* `DXDO_ENABLE_EXPERIMENTAL_COMMANDS=true dx-do help commands` — list with `[experimental]` tag.
|
|
546
|
+
* The `README.md` shipped with the binary — generated with experimental commands always included; each is suffixed with `[experimental]`.
|
|
547
|
+
|
|
548
|
+
When an MCP client (Claude Code, Cursor, mcp-inspector) spawns `dx-do` as a subprocess for a currently-experimental command (e.g. `agentic mcp`), set the env var in the spawn config so the gate is open for the child process. The bundled `investigate@dx-do` Claude Code plugin already does this in its `plugin.json`.
|
|
549
|
+
|
|
550
|
+
|
|
504
551
|
#### version 3 configuration
|
|
505
552
|
|
|
506
553
|
Please upgrade version 3 configurations using "config upgrade"
|