From 0990ece0c854e12133cdf03870dd8a86ea266ed8 Mon Sep 17 00:00:00 2001 From: Marlon Martin Date: Mon, 8 Jun 2026 11:10:04 +0800 Subject: [PATCH] docs: add npx skills install command to README, agent-skills ref, and getting-started --- README.md | 6 ++++++ apps/docs/content/docs/reference/agent-skills.mdx | 8 ++++++++ apps/docs/content/docs/tutorials/getting-started.mdx | 11 ++++++++--- 3 files changed, 22 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9889275..e6929ca 100644 --- a/README.md +++ b/README.md @@ -124,6 +124,12 @@ See [ROADMAP.md](ROADMAP.md) for planned features: cost tracking, offline evalua `skills/regtrace/` teaches AI coding agents how to use regtrace — golden sets, evaluation, regression, CI integration. +```bash +npx skills add decimozs/regtrace/skills/regtrace +``` + +Once installed, type `/regtrace init` in your agent's chat to auto-detect LLM calls and scaffold the project. + ## Launch links - [Product Hunt](https://www.producthunt.com/p/regtrace) diff --git a/apps/docs/content/docs/reference/agent-skills.mdx b/apps/docs/content/docs/reference/agent-skills.mdx index 9c8f71d..558ac3b 100644 --- a/apps/docs/content/docs/reference/agent-skills.mdx +++ b/apps/docs/content/docs/reference/agent-skills.mdx @@ -7,6 +7,14 @@ description: Agent skill for teaching AI agents about the regtrace CLI use the regtrace CLI. Agents load it automatically when a user asks about LLM output quality, golden sets, or regtrace commands. +## Installation + +```bash +npx skills add decimozs/regtrace/skills/regtrace +``` + +This registers the skill with your agent harness (OpenCode, Claude Code, Cursor, Zed, etc.). The agent then loads it automatically when you ask about LLM quality, golden sets, or regtrace commands. + ## Contents | File | Purpose | diff --git a/apps/docs/content/docs/tutorials/getting-started.mdx b/apps/docs/content/docs/tutorials/getting-started.mdx index 0d34e20..3f5bbdb 100644 --- a/apps/docs/content/docs/tutorials/getting-started.mdx +++ b/apps/docs/content/docs/tutorials/getting-started.mdx @@ -58,9 +58,14 @@ This creates: - `.regtrace/runs/` — local run storage - **Using an AI coding agent?** Run `/regtrace init` in OpenCode, Claude Code, - Cursor, or Zed to auto-detect LLM calls in your project and generate - tailored golden sets — no manual editing needed. See the + **Using an AI coding agent?** First install the regtrace skill: + + ```bash + npx skills add decimozs/regtrace/skills/regtrace + ``` + + Then run `/regtrace init` in your agent's chat to auto-detect LLM calls + and generate tailored golden sets — no manual editing needed. See the [Agent Skill](/docs/reference/agent-skills) reference.