@withgauge/cli 0.12.1 → 0.14.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
@@ -6,6 +6,7 @@ live from your terminal.
6
6
 
7
7
  ```sh
8
8
  npm install -g @withgauge/cli
9
+ gauge update # update the CLI to the latest published version
9
10
  gauge onboard # sign in, create a workspace, seed starter measurements
10
11
  gauge auth login # (or just sign in)
11
12
  gauge orgs use <org> # set your default organization
@@ -13,6 +14,18 @@ gauge orgs use <org> # set your default organization
13
14
 
14
15
  Requires Node.js ≥ 22.12.
15
16
 
17
+ Installing or upgrading the CLI also installs the
18
+ [`gauge-agents` skill](https://github.com/gauge-sh/gauge-skills/tree/main/gauge-agents)
19
+ globally through the `skills` installer, without prompts. It uses the installer's
20
+ agent detection for tools such as Codex and Claude Code. Skill installation
21
+ needs network access; failures leave the CLI installed and print a retry command.
22
+ It is skipped in CI or when `GAUGE_SKIP_SKILL_INSTALL=1` is set. If you install
23
+ with `--ignore-scripts`, install the skill manually:
24
+
25
+ ```sh
26
+ npx --yes skills@1.5.0 add gauge-sh/gauge-skills --skill gauge-agents --global --yes
27
+ ```
28
+
16
29
  ## Usage
17
30
 
18
31
  ```sh
@@ -27,15 +40,21 @@ gauge stats rankings -o json # brand rankings (share of voice) as JSON
27
40
  gauge query -d ecosystem -m installs,install_rate -o json # a flexible report
28
41
  ```
29
42
 
30
- `gauge instructions` prints the CLI's own agent instructions to stdout: one
31
- skill file covering every command group. `gauge instructions <topic>` reprints
32
- one group alone. `gauge --help` points agents at it, or write the file into the
33
- repo with `gauge instructions --install`. The text ships inside the CLI, so it
43
+ `gauge instructions` prints a Gauge overview, CLI setup and usage rules, and
44
+ roughly 100 words of essential guidance per module. Each summary points to
45
+ `gauge instructions <topic>` for the full page. `gauge --help` points agents at
46
+ it, or write the file into the repo with `gauge instructions --install`.
47
+ The text ships inside the CLI, so it
34
48
  never drifts from the commands it describes.
35
49
 
50
+ Use `gauge instructions evals` before creating evals: it covers developer tasks,
51
+ model selection, observable judging criteria, and a complete migration example.
52
+ Use `gauge instructions optimization` for the full optimization workflow.
53
+ `gauge instructions --list` shows available topics.
54
+ `gauge instructions evals --install` installs the eval guidance as a local skill.
55
+
36
56
  Run `gauge --help` (or `gauge <command> --help`) for the full command set:
37
57
  evals, preference, models, personas, skills, mcp, repos, runs, optimizations,
38
- experiments,
39
58
  batches, brands, tags, actions, dashboards, members, org, provider keys,
40
59
  billing, usage, stats, query, and more.
41
60