@eigenpal/cli 0.14.2 → 0.15.0

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.
@@ -56,6 +56,26 @@ Commands that can prompt or block (always inspect `--help` for the exact flag):
56
56
  If a command fails with “requires --yes when run non-interactively”, re-run with
57
57
  `--yes` only when the action is intentional — never to blindly retry.
58
58
 
59
+ ## Read Authoritative Docs Before Authoring
60
+
61
+ The CLI bundles release-matched platform documentation. Search it before guessing
62
+ workflow fields, evaluator rules, dataset paths, or command flags:
63
+
64
+ ```bash
65
+ eigenpal docs search "unordered matchBy"
66
+ eigenpal docs read reference/workflow-yaml
67
+ eigenpal docs read reference/step-types
68
+ eigenpal docs read reference/evaluators
69
+ eigenpal docs read reference/dataset-format
70
+ eigenpal docs read reference/cli/workflow
71
+ eigenpal docs read api-reference/openapi
72
+ ```
73
+
74
+ The `reference/*` topics contain generated schemas from the same code that
75
+ validates workflows. Step behavior and examples are available under
76
+ `steps/<category>/<name>`, for example `steps/ai/extract`. Use
77
+ `eigenpal docs list --source agent-reference` to enumerate bundled references.
78
+
59
79
  ## Choose A Command
60
80
 
61
81
  - `eigenpal workflow` manages YAML workflow definitions, datasets, evaluators,
@@ -415,6 +435,19 @@ Exit codes:
415
435
 
416
436
  Status messages go to stderr. Pipeable data goes to stdout.
417
437
 
438
+ Flag contract:
439
+
440
+ - `--json` emits the primary payload. `--select <path>` emits one nested value
441
+ as JSON and is preferable to `--json | jq` for stable paths.
442
+ - `--wait` blocks a command that starts work; `--watch` follows an existing
443
+ resource. Polling timeouts exit 2.
444
+ - `--format` selects an export or code-generation encoding, not JSON mode.
445
+ - `runs get --expand` requests server detail sections. `--include` is
446
+ command-specific; never reuse values from another command without checking
447
+ `--help`.
448
+ - `--out` may be a file or a directory depending on the command; the option
449
+ description identifies which.
450
+
418
451
  ## References
419
452
 
420
453
  Use generated references for exact flags and defaults:
@@ -165,14 +165,14 @@ agents
165
165
 
166
166
  ### Experiment
167
167
 
168
- | Command | Description |
169
- | ----------------------------------------------------------------------------------- | ------------------------------------------------ |
170
- | `eigenpal agents experiment\|exp run [options] <agent-id-or-slug>` | Start an experiment over dataset examples. |
171
- | `eigenpal agents experiment\|exp status [options] <agent-id-or-slug> <batch-id>` | Get experiment status. |
172
- | `eigenpal agents experiment\|exp results [options] <agent-id-or-slug> [batch-id]` | Print experiment results as JSON or CSV. |
173
- | `eigenpal agents experiment\|exp list\|ls [options] <agent-id-or-slug>` | List experiments. |
174
- | `eigenpal agents experiment\|exp compare\|diff [options] <batch-id-a> <batch-id-b>` | Diff eval scores between two experiment batches. |
175
- | `eigenpal agents experiment\|exp cancel [options] <agent-id-or-slug> <batch-id>` | Cancel every active execution in an experiment. |
168
+ | Command | Description |
169
+ | ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
170
+ | `eigenpal agents experiment\|exp run [options] <agent-id-or-slug>` | Start an experiment over dataset examples. |
171
+ | `eigenpal agents experiment\|exp status [options] <agent-id-or-slug> <batch-id>` | Get experiment status. |
172
+ | `eigenpal agents experiment\|exp results [options] <agent-id-or-slug> [batch-id]` | Print experiment results as JSON or CSV. |
173
+ | `eigenpal agents experiment\|exp list\|ls [options] <agent-id-or-slug>` | List experiments. |
174
+ | `eigenpal agents experiment\|exp compare\|diff [options] <batch-id-a> <batch-id-b>` | Compare evaluator scores or actual outputs between two experiment batches. |
175
+ | `eigenpal agents experiment\|exp cancel [options] <agent-id-or-slug> <batch-id>` | Cancel every active execution in an experiment. |
176
176
 
177
177
  ### Session
178
178
 
@@ -198,13 +198,13 @@ List agents.
198
198
 
199
199
  ### Options
200
200
 
201
- | Flag | Required | Default | Description |
202
- | ------------------ | -------- | ------- | -------------------------------------- |
203
- | `--base-url <url>` | no | | Server base URL |
204
- | `--limit <n>` | no | `50` | Page size |
205
- | `--offset <n>` | no | `0` | Page offset |
206
- | `--json` | no | | Output the raw server response as JSON |
207
- | `--search <q>` | no | | Search by slug, name, or description |
201
+ | Flag | Required | Default | Description |
202
+ | ------------------ | -------- | ------- | ------------------------------------ |
203
+ | `--base-url <url>` | no | | Server base URL |
204
+ | `--limit <n>` | no | `50` | Page size |
205
+ | `--offset <n>` | no | `0` | Page offset |
206
+ | `--json` | no | | Emit machine-readable JSON on stdout |
207
+ | `--search <q>` | no | | Search by slug, name, or description |
208
208
 
209
209
  ### `eigenpal agents validate [options] [dir]`
210
210
 
@@ -218,9 +218,9 @@ Validate a local agent package (layout, manifest, schemas, and Git source rules)
218
218
 
219
219
  ### Options
220
220
 
221
- | Flag | Required | Default | Description |
222
- | -------- | -------- | ------- | -------------------------------------- |
223
- | `--json` | no | | Output the raw server response as JSON |
221
+ | Flag | Required | Default | Description |
222
+ | -------- | -------- | ------- | ------------------------------------ |
223
+ | `--json` | no | | Emit machine-readable JSON on stdout |
224
224
 
225
225
  ### `eigenpal agents clone [options]`
226
226
 
@@ -334,10 +334,10 @@ Check organization source repository health.
334
334
 
335
335
  ### Options
336
336
 
337
- | Flag | Required | Default | Description |
338
- | ------------- | -------- | ------- | -------------------------------------- |
339
- | `--json` | no | | Output the raw server response as JSON |
340
- | `--dir <dir>` | no | | Directory to inspect |
337
+ | Flag | Required | Default | Description |
338
+ | ------------- | -------- | ------- | ------------------------------------ |
339
+ | `--json` | no | | Emit machine-readable JSON on stdout |
340
+ | `--dir <dir>` | no | | Directory to inspect |
341
341
 
342
342
  ### `eigenpal agents status [options]`
343
343
 
@@ -345,10 +345,10 @@ Show source repo and package status.
345
345
 
346
346
  ### Options
347
347
 
348
- | Flag | Required | Default | Description |
349
- | ------------- | -------- | ------- | -------------------------------------- |
350
- | `--json` | no | | Output the raw server response as JSON |
351
- | `--dir <dir>` | no | | Directory to inspect |
348
+ | Flag | Required | Default | Description |
349
+ | ------------- | -------- | ------- | ------------------------------------ |
350
+ | `--json` | no | | Emit machine-readable JSON on stdout |
351
+ | `--dir <dir>` | no | | Directory to inspect |
352
352
 
353
353
  ### `eigenpal agents deps [options]`
354
354
 
@@ -356,10 +356,10 @@ List package workspace dependencies.
356
356
 
357
357
  ### Options
358
358
 
359
- | Flag | Required | Default | Description |
360
- | ------------- | -------- | ------- | -------------------------------------- |
361
- | `--json` | no | | Output the raw server response as JSON |
362
- | `--dir <dir>` | no | | Directory to inspect |
359
+ | Flag | Required | Default | Description |
360
+ | ------------- | -------- | ------- | ------------------------------------ |
361
+ | `--json` | no | | Emit machine-readable JSON on stdout |
362
+ | `--dir <dir>` | no | | Directory to inspect |
363
363
 
364
364
  ### `eigenpal agents clean [options]`
365
365
 
@@ -383,10 +383,10 @@ Show Git-backed automation details.
383
383
 
384
384
  ### Options
385
385
 
386
- | Flag | Required | Default | Description |
387
- | ------------------ | -------- | ------- | -------------------------------------- |
388
- | `--base-url <url>` | no | | Server base URL |
389
- | `--json` | no | | Output the raw server response as JSON |
386
+ | Flag | Required | Default | Description |
387
+ | ------------------ | -------- | ------- | ------------------------------------ |
388
+ | `--base-url <url>` | no | | Server base URL |
389
+ | `--json` | no | | Emit machine-readable JSON on stdout |
390
390
 
391
391
  ### `eigenpal agents versions [options] <package>`
392
392
 
@@ -400,10 +400,10 @@ List package release versions.
400
400
 
401
401
  ### Options
402
402
 
403
- | Flag | Required | Default | Description |
404
- | ------------------ | -------- | ------- | -------------------------------------- |
405
- | `--base-url <url>` | no | | Server base URL |
406
- | `--json` | no | | Output the raw server response as JSON |
403
+ | Flag | Required | Default | Description |
404
+ | ------------------ | -------- | ------- | ------------------------------------ |
405
+ | `--base-url <url>` | no | | Server base URL |
406
+ | `--json` | no | | Emit machine-readable JSON on stdout |
407
407
 
408
408
  ### `eigenpal agents release [options] <version> [dir]`
409
409
 
@@ -455,7 +455,7 @@ List live files for an agent.
455
455
  | Flag | Required | Default | Description |
456
456
  | ------------------ | -------- | ------- | ------------------------------------------ |
457
457
  | `--base-url <url>` | no | | Server base URL |
458
- | `--json` | no | | Output the raw server response as JSON |
458
+ | `--json` | no | | Emit machine-readable JSON on stdout |
459
459
  | `--path <prefix>` | no | | Only list files beneath this relative path |
460
460
 
461
461
  ### `eigenpal agents file get [options] <agent-id-or-slug> <remote-path>`
@@ -471,11 +471,11 @@ Download one live agent file.
471
471
 
472
472
  ### Options
473
473
 
474
- | Flag | Required | Default | Description |
475
- | ------------------ | -------- | ------- | -------------------------------------- |
476
- | `--base-url <url>` | no | | Server base URL |
477
- | `--json` | no | | Output the raw server response as JSON |
478
- | `--out <file>` | no | | Output file path |
474
+ | Flag | Required | Default | Description |
475
+ | ------------------ | -------- | ------- | ------------------------------------ |
476
+ | `--base-url <url>` | no | | Server base URL |
477
+ | `--json` | no | | Emit machine-readable JSON on stdout |
478
+ | `--out <file>` | no | | Output file path |
479
479
 
480
480
  ### `eigenpal agents file diff [options] <agent-id-or-slug> <remote-path> <local-path>`
481
481
 
@@ -491,10 +491,10 @@ Compare one live agent file against a local file.
491
491
 
492
492
  ### Options
493
493
 
494
- | Flag | Required | Default | Description |
495
- | ------------------ | -------- | ------- | -------------------------------------- |
496
- | `--base-url <url>` | no | | Server base URL |
497
- | `--json` | no | | Output the raw server response as JSON |
494
+ | Flag | Required | Default | Description |
495
+ | ------------------ | -------- | ------- | ------------------------------------ |
496
+ | `--base-url <url>` | no | | Server base URL |
497
+ | `--json` | no | | Emit machine-readable JSON on stdout |
498
498
 
499
499
  ### `eigenpal agents secrets|secret list|ls [options]`
500
500
 
@@ -502,10 +502,10 @@ List secret names declared in secrets.enc.yaml (never prints values).
502
502
 
503
503
  ### Options
504
504
 
505
- | Flag | Required | Default | Description |
506
- | ------------- | -------- | ------- | -------------------------------------- |
507
- | `--json` | no | | Output the raw server response as JSON |
508
- | `--dir <dir>` | no | | Directory to inspect |
505
+ | Flag | Required | Default | Description |
506
+ | ------------- | -------- | ------- | ------------------------------------ |
507
+ | `--json` | no | | Emit machine-readable JSON on stdout |
508
+ | `--dir <dir>` | no | | Directory to inspect |
509
509
 
510
510
  ### `eigenpal agents secrets|secret set [options] <name>`
511
511
 
@@ -588,12 +588,12 @@ List dataset examples for an agent.
588
588
 
589
589
  ### Options
590
590
 
591
- | Flag | Required | Default | Description |
592
- | ------------------ | -------- | ------- | -------------------------------------- |
593
- | `--base-url <url>` | no | | Server base URL |
594
- | `--limit <n>` | no | `50` | Page size |
595
- | `--offset <n>` | no | `0` | Page offset |
596
- | `--json` | no | | Output the raw server response as JSON |
591
+ | Flag | Required | Default | Description |
592
+ | ------------------ | -------- | ------- | ------------------------------------ |
593
+ | `--base-url <url>` | no | | Server base URL |
594
+ | `--limit <n>` | no | `50` | Page size |
595
+ | `--offset <n>` | no | `0` | Page offset |
596
+ | `--json` | no | | Emit machine-readable JSON on stdout |
597
597
 
598
598
  ### `eigenpal agents dataset push [options] <agent-id-or-slug>`
599
599
 
@@ -610,7 +610,7 @@ Upload dataset examples from a local dataset directory or zip archive.
610
610
  | Flag | Required | Default | Description |
611
611
  | -------------------------- | -------- | ---------- | ---------------------------------------------------------------------------------- |
612
612
  | `--base-url <url>` | no | | Server base URL |
613
- | `--json` | no | | Output the raw server response as JSON |
613
+ | `--json` | no | | Emit machine-readable JSON on stdout |
614
614
  | `--file <path>` | yes | | Dataset directory or .zip archive |
615
615
  | `--mode <append\|replace>` | no | `"append"` | Upload mode |
616
616
  | `--yes` | no | | Skip typed-slug confirmation for --mode replace (required in CI / agent terminals) |
@@ -646,7 +646,7 @@ Validate a local dataset directory against the canonical examples/<name> layout.
646
646
 
647
647
  | Flag | Required | Default | Description |
648
648
  | ------------------- | -------- | ------- | --------------------------------------------------------------------------------------- |
649
- | `--json` | no | | Output the raw server response as JSON |
649
+ | `--json` | no | | Emit machine-readable JSON on stdout |
650
650
  | `--agent-dir <dir>` | no | `"."` | Agent package directory with optional input/output schemas for extra value-level checks |
651
651
 
652
652
  ### `eigenpal agents experiment|exp run [options] <agent-id-or-slug>`
@@ -664,10 +664,11 @@ Start an experiment over dataset examples.
664
664
  | Flag | Required | Default | Description |
665
665
  | ---------------------- | -------- | ------- | --------------------------------------------------- |
666
666
  | `--base-url <url>` | no | | Server base URL |
667
- | `--json` | no | | Output the raw server response as JSON |
667
+ | `--json` | no | | Emit machine-readable JSON on stdout |
668
668
  | `--example-id <id>` | no | | Run one dataset example |
669
669
  | `--wait` | no | | Poll until the experiment reaches a terminal status |
670
670
  | `--interval <seconds>` | no | `2` | Polling interval in seconds |
671
+ | `--max-wait <seconds>` | no | `1800` | Maximum wait before exit code 2 |
671
672
 
672
673
  ### `eigenpal agents experiment|exp status [options] <agent-id-or-slug> <batch-id>`
673
674
 
@@ -682,14 +683,13 @@ Get experiment status.
682
683
 
683
684
  ### Options
684
685
 
685
- | Flag | Required | Default | Description |
686
- | ---------------------- | -------- | ------- | -------------------------------------- |
687
- | `--base-url <url>` | no | | Server base URL |
688
- | `--json` | no | | Output the raw server response as JSON |
689
- | `--watch` | no | | Poll until complete |
690
- | `--interval <seconds>` | no | `2` | Polling interval in seconds |
691
- | `--max-wait <seconds>` | no | `1800` | Maximum wait before exit code 2 |
692
- | `--include <parts>` | no | | Reserved for future detailed parts |
686
+ | Flag | Required | Default | Description |
687
+ | ---------------------- | -------- | ------- | ------------------------------------ |
688
+ | `--base-url <url>` | no | | Server base URL |
689
+ | `--json` | no | | Emit machine-readable JSON on stdout |
690
+ | `--watch` | no | | Poll until complete |
691
+ | `--interval <seconds>` | no | `2` | Polling interval in seconds |
692
+ | `--max-wait <seconds>` | no | `1800` | Maximum wait before exit code 2 |
693
693
 
694
694
  ### `eigenpal agents experiment|exp results [options] <agent-id-or-slug> [batch-id]`
695
695
 
@@ -704,11 +704,16 @@ Print experiment results as JSON or CSV.
704
704
 
705
705
  ### Options
706
706
 
707
- | Flag | Required | Default | Description |
708
- | ---------------------- | -------- | ------- | -------------------- |
709
- | `--base-url <url>` | no | | Server base URL |
710
- | `--format <csv\|json>` | yes | | Output format |
711
- | `--out <path>` | no | | Write output to file |
707
+ | Flag | Required | Default | Description |
708
+ | ---------------------- | -------- | -------- | ---------------------------------------------------------------------------------------- |
709
+ | `--base-url <url>` | no | | Server base URL |
710
+ | `--json` | no | | Emit machine-readable JSON on stdout |
711
+ | `--format <csv\|json>` | no | `"json"` | Output format (default json) |
712
+ | `--out <path>` | no | | Write output to file |
713
+ | `--summary` | no | | Show total/pass/fail/error counts, average score, and evaluator rollups |
714
+ | `--failed-only` | no | | Keep only failed or errored evaluator results |
715
+ | `--evaluator <name>` | no | | Keep only results from this evaluator |
716
+ | `--select <path>` | no | | Print only a nested JSON value (for example summary.byEvaluator or discrepancies[].path) |
712
717
 
713
718
  ### `eigenpal agents experiment|exp list|ls [options] <agent-id-or-slug>`
714
719
 
@@ -722,17 +727,17 @@ List experiments.
722
727
 
723
728
  ### Options
724
729
 
725
- | Flag | Required | Default | Description |
726
- | ------------------ | -------- | ------- | -------------------------------------- |
727
- | `--base-url <url>` | no | | Server base URL |
728
- | `--limit <n>` | no | `50` | Page size |
729
- | `--offset <n>` | no | `0` | Page offset |
730
- | `--json` | no | | Output the raw server response as JSON |
731
- | `--batch-id <id>` | no | | Filter to one batch id |
730
+ | Flag | Required | Default | Description |
731
+ | ------------------ | -------- | ------- | ------------------------------------ |
732
+ | `--base-url <url>` | no | | Server base URL |
733
+ | `--limit <n>` | no | `50` | Page size |
734
+ | `--offset <n>` | no | `0` | Page offset |
735
+ | `--json` | no | | Emit machine-readable JSON on stdout |
736
+ | `--batch-id <id>` | no | | Filter to one batch id |
732
737
 
733
738
  ### `eigenpal agents experiment|exp compare|diff [options] <batch-id-a> <batch-id-b>`
734
739
 
735
- Diff eval scores between two experiment batches.
740
+ Compare evaluator scores or actual outputs between two experiment batches.
736
741
 
737
742
  ### Arguments
738
743
 
@@ -746,7 +751,8 @@ Diff eval scores between two experiment batches.
746
751
  | Flag | Required | Default | Description |
747
752
  | ------------------------------------------------------ | -------- | ------------------ | ------------------------------------------------------ |
748
753
  | `--base-url <url>` | no | | Server base URL |
749
- | `--json` | no | | Output the raw server response as JSON |
754
+ | `--json` | no | | Emit machine-readable JSON on stdout |
755
+ | `--outputs` | no | | Compare actual run outputs instead of evaluator scores |
750
756
  | `--sort <abs-delta-desc\|delta-asc\|delta-desc\|name>` | no | `"abs-delta-desc"` | Row sort order (default: biggest movers first) |
751
757
  | `--regression-threshold <n>` | no | `0.05` | Δ below this is flagged as a regression (default 0.05) |
752
758
 
@@ -766,7 +772,7 @@ Cancel every active execution in an experiment.
766
772
  | Flag | Required | Default | Description |
767
773
  | ------------------ | -------- | ------- | ------------------------------------------------------------------ |
768
774
  | `--base-url <url>` | no | | Server base URL |
769
- | `--json` | no | | Output the raw server response as JSON |
775
+ | `--json` | no | | Emit machine-readable JSON on stdout |
770
776
  | `--yes` | no | | Skip confirmation (required in CI / agent terminals without a TTY) |
771
777
 
772
778
  ### `eigenpal agents session list|ls [options] <agent-id-or-slug>`
@@ -781,12 +787,12 @@ List builder sessions for an agent.
781
787
 
782
788
  ### Options
783
789
 
784
- | Flag | Required | Default | Description |
785
- | ------------------ | -------- | ------- | -------------------------------------- |
786
- | `--base-url <url>` | no | | Server base URL |
787
- | `--limit <n>` | no | `50` | Page size |
788
- | `--offset <n>` | no | `0` | Page offset |
789
- | `--json` | no | | Output the raw server response as JSON |
790
+ | Flag | Required | Default | Description |
791
+ | ------------------ | -------- | ------- | ------------------------------------ |
792
+ | `--base-url <url>` | no | | Server base URL |
793
+ | `--limit <n>` | no | `50` | Page size |
794
+ | `--offset <n>` | no | `0` | Page offset |
795
+ | `--json` | no | | Emit machine-readable JSON on stdout |
790
796
 
791
797
  ### `eigenpal agents session get [options] <session-id>`
792
798
 
@@ -800,10 +806,10 @@ Get a builder session and messages.
800
806
 
801
807
  ### Options
802
808
 
803
- | Flag | Required | Default | Description |
804
- | ------------------ | -------- | ------- | -------------------------------------- |
805
- | `--base-url <url>` | no | | Server base URL |
806
- | `--json` | no | | Output the raw server response as JSON |
809
+ | Flag | Required | Default | Description |
810
+ | ------------------ | -------- | ------- | ------------------------------------ |
811
+ | `--base-url <url>` | no | | Server base URL |
812
+ | `--json` | no | | Emit machine-readable JSON on stdout |
807
813
 
808
814
  ### `eigenpal agents session start [options] <agent-id-or-slug>`
809
815
 
@@ -817,11 +823,11 @@ Start a builder session.
817
823
 
818
824
  ### Options
819
825
 
820
- | Flag | Required | Default | Description |
821
- | ------------------ | -------- | ------- | -------------------------------------- |
822
- | `--base-url <url>` | no | | Server base URL |
823
- | `--json` | no | | Output the raw server response as JSON |
824
- | `--title <title>` | no | | Session title |
826
+ | Flag | Required | Default | Description |
827
+ | ------------------ | -------- | ------- | ------------------------------------ |
828
+ | `--base-url <url>` | no | | Server base URL |
829
+ | `--json` | no | | Emit machine-readable JSON on stdout |
830
+ | `--title <title>` | no | | Session title |
825
831
 
826
832
  ### `eigenpal agents session message [options] <session-id>`
827
833
 
@@ -835,12 +841,11 @@ Append a message to a builder session.
835
841
 
836
842
  ### Options
837
843
 
838
- | Flag | Required | Default | Description |
839
- | ------------------ | -------- | ------- | ---------------------------------------------------------- |
840
- | `--base-url <url>` | no | | Server base URL |
841
- | `--json` | no | | Output the raw server response as JSON |
842
- | `--text <message>` | yes | | Message text |
843
- | `--wait` | no | | Reserved; server acknowledges after enqueueing the message |
844
+ | Flag | Required | Default | Description |
845
+ | ------------------ | -------- | ------- | ------------------------------------ |
846
+ | `--base-url <url>` | no | | Server base URL |
847
+ | `--json` | no | | Emit machine-readable JSON on stdout |
848
+ | `--text <message>` | yes | | Message text |
844
849
 
845
850
  ### `eigenpal agents session stop [options] <session-id>`
846
851
 
@@ -857,7 +862,7 @@ Stop a builder session.
857
862
  | Flag | Required | Default | Description |
858
863
  | ------------------ | -------- | ------- | ------------------------------------------------------------------ |
859
864
  | `--base-url <url>` | no | | Server base URL |
860
- | `--json` | no | | Output the raw server response as JSON |
865
+ | `--json` | no | | Emit machine-readable JSON on stdout |
861
866
  | `--yes` | no | | Skip confirmation (required in CI / agent terminals without a TTY) |
862
867
 
863
868
  ### `eigenpal agents env pull [options] [target]`
@@ -0,0 +1,84 @@
1
+ # eigenpal docs
2
+
3
+ List, search, and read the complete release-matched Eigenpal documentation offline.
4
+
5
+ ## Contents
6
+
7
+ - [Surface](#surface)
8
+ - [Commands](#commands)
9
+ - [Core](#core)
10
+ - [Details](#details)
11
+ - [`eigenpal docs list|ls [options] [prefix]`](#eigenpal-docs-listls-options-prefix)
12
+ - [`eigenpal docs search [options] <query>`](#eigenpal-docs-search-options-query)
13
+ - [`eigenpal docs read [options] <topic>`](#eigenpal-docs-read-options-topic)
14
+
15
+ ## Surface
16
+
17
+ ```
18
+ docs
19
+ ├── list|ls [prefix]
20
+ ├── search <query>
21
+ └── read <topic>
22
+ ```
23
+
24
+ ## Commands
25
+
26
+ ### Core
27
+
28
+ | Command | Description |
29
+ | ------------------------------------------- | ------------------------------------------------------------------ |
30
+ | `eigenpal docs list\|ls [options] [prefix]` | List bundled documentation topics, optionally under a path prefix. |
31
+ | `eigenpal docs search [options] <query>` | Search every public page and detailed agent reference. |
32
+ | `eigenpal docs read [options] <topic>` | Print one bundled documentation topic to stdout. |
33
+
34
+ ## Details
35
+
36
+ ### `eigenpal docs list|ls [options] [prefix]`
37
+
38
+ List bundled documentation topics, optionally under a path prefix.
39
+
40
+ ### Arguments
41
+
42
+ | Name | Required | Variadic | Description |
43
+ | -------- | -------- | -------- | ----------- |
44
+ | `prefix` | no | no | |
45
+
46
+ ### Options
47
+
48
+ | Flag | Required | Default | Description |
49
+ | ------------------- | -------- | ------- | ----------------------------------------- |
50
+ | `--json` | no | | Emit machine-readable JSON on stdout |
51
+ | `--source <source>` | no | | Filter by public, agent-reference, or api |
52
+
53
+ ### `eigenpal docs search [options] <query>`
54
+
55
+ Search every public page and detailed agent reference.
56
+
57
+ ### Arguments
58
+
59
+ | Name | Required | Variadic | Description |
60
+ | ------- | -------- | -------- | ----------- |
61
+ | `query` | yes | no | |
62
+
63
+ ### Options
64
+
65
+ | Flag | Required | Default | Description |
66
+ | ------------- | -------- | ------- | ------------------------------------ |
67
+ | `--json` | no | | Emit machine-readable JSON on stdout |
68
+ | `--limit <n>` | no | `20` | Maximum matches |
69
+
70
+ ### `eigenpal docs read [options] <topic>`
71
+
72
+ Print one bundled documentation topic to stdout.
73
+
74
+ ### Arguments
75
+
76
+ | Name | Required | Variadic | Description |
77
+ | ------- | -------- | -------- | ----------- |
78
+ | `topic` | yes | no | |
79
+
80
+ ### Options
81
+
82
+ | Flag | Required | Default | Description |
83
+ | -------- | -------- | ------- | ------------------------------------ |
84
+ | `--json` | no | | Emit machine-readable JSON on stdout |
@@ -37,4 +37,4 @@ List configured text, vision, and OCR models. This is a catalog inventory from t
37
37
  | --------------------- | -------- | ------- | -------------------------------------------------------------------------- |
38
38
  | `--capability <kind>` | no | | Filter to `text`, `vision`, or `ocr` (matches the API `capability` query). |
39
39
  | `--base-url <url>` | no | | Server base URL |
40
- | `--json` | no | | Output the raw server response as JSON |
40
+ | `--json` | no | | Emit machine-readable JSON on stdout |
@@ -13,7 +13,7 @@ Create a new run from a previous run's stored input snapshot.
13
13
  | Flag | Required | Default | Description |
14
14
  | ---------------------- | -------- | ---------- | ------------------------------------------------------------------------ |
15
15
  | `--base-url <url>` | no | | Server base URL |
16
- | `--json` | no | | Output the raw server response as JSON |
16
+ | `--json` | no | | Emit machine-readable JSON on stdout |
17
17
  | `--version <version>` | no | `"latest"` | Version/source ref for the new run: latest, original, or an explicit ref |
18
18
  | `--wait` | no | | Poll until the rerun reaches a terminal status |
19
19
  | `--interval <seconds>` | no | `2` | Polling interval in seconds |
@@ -13,7 +13,7 @@ Start a workflow or agent run, e.g. workflows.extract-invoice.
13
13
  | Flag | Required | Default | Description |
14
14
  | --------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
15
  | `--base-url <url>` | no | | Server base URL |
16
- | `--json` | no | | Output the raw server response as JSON |
16
+ | `--json` | no | | Emit machine-readable JSON on stdout |
17
17
  | `--input-json <json>` | no | | JSON input object |
18
18
  | `--input-file <field=path>` | no | `[]` | Input file to upload. Files exceeding EIGENPAL_MULTIPART_MAX_BYTES (default 4.5 MiB; "none" disables) are pre-uploaded; smaller files stay on multipart. Repeat for multiple files; bare paths use field "file". |
19
19
  | `--example <name>` | no | | Run one persisted example by name |