@withgauge/cli 0.29.0 → 0.30.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.
package/README.md CHANGED
@@ -566,6 +566,66 @@ JSON is still the only output. Automatic PR checks continue to use configured
566
566
  sources; disable those checks in Gauge's GitHub settings if CI owns the trigger.
567
567
  Save `results.json` as a CI artifact even when the check fails.
568
568
 
569
+ ### Self-contained product experiments (hosted)
570
+
571
+ A self-contained experiment supplies its product revision, input declarations,
572
+ and cases in one JSON file. It needs no checkout or `gauge.json`. Gauge resolves
573
+ the product through your organization's GitHub App connection; grant the App
574
+ access to that repository, including when it is public.
575
+
576
+ ```sh
577
+ gauge run --example --format experiment > experiment.json
578
+ # Edit the product, inputs, task, and criteria, then preview:
579
+ gauge run --hosted --org <org> --apply experiment.json --dry-run -o json > preview.json
580
+ # Save the resolved commit so a branch moving cannot change the launch:
581
+ jq '.experiment' preview.json > pinned-experiment.json
582
+ gauge run --hosted --org <org> --apply pinned-experiment.json --yes -o json
583
+ ```
584
+
585
+ For example:
586
+
587
+ ```json
588
+ {
589
+ "version": 2,
590
+ "product": { "repository": "example/product", "revision": "main" },
591
+ "inputs": { "docs": { "type": "files", "paths": ["docs/**"] } },
592
+ "cases": [{
593
+ "key": "first-request",
594
+ "prompt": "Use the supplied documentation to write a minimal API client.",
595
+ "criteria": [{ "name": "Working example", "rubric": "The client follows the documented API contract." }],
596
+ "config": { "agents": [{ "agent": "CODEX_CLI" }], "inputs": ["docs"] }
597
+ }]
598
+ }
599
+ ```
600
+
601
+ `product.repository` accepts `owner/repository` or an HTTPS GitHub repository URL;
602
+ `revision` accepts a branch, tag, or full commit SHA. Each invocation resolves it
603
+ once. The preview includes the immutable revision in `experiment`, suitable for
604
+ another `--apply`. Reusing the original branch-based file resolves the branch anew.
605
+ Use `gauge run --schema --format experiment` for the complete authoring schema.
606
+
607
+ Input declarations use the same vocabulary as `gauge.json`: files, skills,
608
+ npm packages, binaries, web fixtures, and website previews. All product inputs
609
+ come from the selected repository and commit, using the declared Git, Actions,
610
+ or deployment source. An npm input selects an existing packed `.tgz` from Git or
611
+ an Actions artifact; Gauge does not build a package directory for you.
612
+
613
+ The tested agent's consumer workspace is separate. Omit `cases[].config.repoUrl`
614
+ to use the default workspace, or set it explicitly for a consumer project.
615
+ The product repository does not become the consumer workspace. Cases select
616
+ named inputs through `config.inputs`; omitting the selection includes all inputs
617
+ declared in this specification. An explicit empty `inputs` object is allowed.
618
+
619
+ This form never discovers cases or inputs from the working directory and does
620
+ not upload local files. `--input` overrides, `--cli-rules`, and local execution
621
+ are unavailable for this form. Existing case specifications keep their normal
622
+ workspace behavior. A preview validates the plan and reports source readiness;
623
+ it may read source metadata and manifests, but does not prepare input artifacts
624
+ or start sessions. Pinning a commit
625
+ does not freeze a future CI artifact or deployment: preparation records the
626
+ actual artifacts and receipts when the request runs. Launches use the ordinary
627
+ organization permissions, execution limits, and credits.
628
+
569
629
  ### Antigravity (hosted)
570
630
 
571
631
  Antigravity is available to organizations enrolled in Antigravity access. Run