Test whether coding agents can use your latest product changes before you merge a pull request.
The Gauge Agents GitHub App reads configuration from your PR, injects your changes into coding sessions, and reports the results in a PR comment and status check. To run from your own CI without the App, use local inputs and JSON results.
Start with your coding agent. We recommend the gauge-agents
Skill and
Gauge CLI. The Skill’s dedicated PR setup instructions help your agent inspect
the repository, reuse existing CI or previews, and verify the configuration.
Follow the copy-paste setup below.
Set up with your coding agent
Run this in your repository to install the CLI and Skill, sign in, and confirm your access:
Then start a new coding-agent session in the repository so it can discover the installed Skill, and paste:
Use the gauge-agents Skill and its GitHub PR setup instructions toset up Gauge PR checks in this repository. Run gauge instructions first.Inspect the repo and reuse its existing CI artifacts or public previews.Help me choose the product surface to test, a realistic task, and successcriteria. Use my actual Gauge organization; ask if there is a choice.Create or update gauge.json and one eval case with one agent and one sample,preserving existing configuration and cases. Consult the published configand case schemas for supported fields and enum values.Run gauge run --verify -o json, fix definite failures, and explain anyremaining unknowns. Show me the changes and the remaining GitHub Appinstallation or target-branch settings needed before I open a PR.
Before you open a PR, complete the GitHub App installation and configure repository settings below to enable Gauge PR Checks. The install, sign-in, and verification commands do not launch coding sessions.
Set up your first pull request eval
1
Install the Gauge GitHub App
Open Settings → GitHub and select Install GitHub App.
Connect GitHub from your organization's settings.
On GitHub, choose your account and select the repositories whose CLI, docs, or Skills you want to test. Return to Gauge to see the connected account and its repositories.If GitHub requests an account owner’s approval, finish that approval before continuing. See repository access and troubleshooting.
2
Configure pull request checks for each repository
On the same Settings → GitHub page, find Pull request checks. Enable checks for each repository you want to test.Use Edit beside Target branches to choose which branches should receive checks. For example, select main to test PRs that merge into main. These are the PR’s destination branches.Repositories without custom settings default to checks enabled for main. Branch names are exact names, such as main or release/next, rather than glob patterns. Changing these settings does not itself launch an evaluation; use a new PR update or rerun an existing check after setup.
Enable checks and choose target branches independently for each repository.
3
Create gauge.json
Create gauge.json at the repository root and copy an input configuration below. Then sign in with gauge auth login and run gauge orgs use <slug> --project, using your organization’s slug from gauge orgs. This records the organization as orgId in gauge.json. That organization must own the App installation connected to this repository.Use the configuration schema for accepted fields, input types, and enum values. See schemas and enums for validation guidance.This file tells Gauge what to make available to the agent. Packages and native executables come from your existing CI, docs pages come from a public preview, and Skills or files can come directly from the PR’s commit. Gauge consumes these inputs; it does not trigger builds. Custom prepare/install scripts are not supported in gauge.json.gauge-cases/**/*.md is the default case location. Before CLI 0.22.0 it was gauge-evals/; rename that folder or list it in cases. The examples declare the location explicitly. No github.enabled field is needed; repository access and target branches are controlled in Settings → GitHub.
4
Write your first eval case
Create gauge-cases/onboarding.md. Start with this Agent Experience template and replace the task and success criterion before opening the PR. To measure product selection, use an Agent Preference case instead.
gauge-cases/onboarding.md
---criteria: - name: Replace with your success criterion rubric: >- Describe the observable result that shows the agent completed the task successfully.config: agents: - agent: CLAUDE_CODE sampleCount: 1---Write what an agent should be able to do with your product here,like onboarding. Include any context the agent needs and how itshould verify that the task worked.
The Markdown body is the agent’s task. The criterion tells Gauge how to judge the result and is not shown to the agent. For example, an onboarding task might ask the agent to set up your product and run its first command; the criterion could require a successful response from that command.The eval-case schema describes the YAML frontmatter, including the exact agent enum values. Use CLAUDE_CODE, CODEX_CLI, PI, or OPENCODE, or ANTIGRAVITY with an explicit model in models; lowercase CLI aliases such as claude-code are not valid here.By default, the case uses every input in gauge.json. To choose specific inputs, add inputs: [cli], inputs: [docs], or inputs: [product-skill] under config, using the names from your configuration.If the task needs an existing application, add repoUrl and repoRef under config, such as https://github.com/your-org/example-app and main. Otherwise, the agent starts in an empty workspace. Each case owns its agent and sample settings. Start with one agent and one sample.The consumer application is separate from the repository supplying the PR’s inputs. Use a pinned commit in repoRef when you need a repeatable starting point. Omitting models uses the harness default; run gauge models list --hosted -o json after signing in to choose and pin available model IDs under each agent’s models array.
5
Verify the setup locally
From the repository, check your working files before committing:
gauge run --verifygauge run --verify -o json
Verification works offline without login or a PR. It inspects configuration, case input references, Git input paths in the working tree, and recognizable workflow declarations. yes means a local check passed, no means a definite problem, and unknown means that declaration could not be resolved statically. Exit code 1 indicates a definite problem; exit code 0 can still include unknowns.Fix the no results and inspect any unknown results. Verification does not execute CI, inspect built artifacts, prove installation, check App activation, or start sessions. A repository with no cases is reported as information, so also confirm that it found the case you just wrote.Optionally, sign in and preview the setup on hosted Gauge:
gauge auth logingauge run --hosted --dry-run
The dry run shows the session count and input readiness without launching sessions. It reads your working-tree cases and inputs, including uncommitted edits, and may upload inputs. PR checks read the committed files. Use --input to test a local build.
6
Open a pull request and review the result
Commit gauge.json, your eval case, and the changes you want to test. Open a PR targeting a configured branch in the connected repository.Gauge adds a Gauge evaluations check to the latest commit. It reads the committed evals, waits for any required package or docs preview, then starts the sessions. You can include the configuration in your first PR; it does not need to be merged first. Fork pull requests require workspace approval.The PR comment updates through input preparation, execution, and analysis. Agent Experience cases report pass/fail; Agent Preference cases report product selections. Open the session links to review messages, commands, code changes, and explanations. Use that evidence to improve your product, then push a new commit to test again.
Measure Agent Preference
Use preference instead of criteria to measure which brand or product the agent selects. Each case declares exactly one of these fields. Preference cases use the same analysis as prompts in the app and report advisory results.
Preference frontmatter requires a CLI release with Git-authored Agent
Preference support and the v2.6.0 case schema. CLI 0.16.0 and earlier reject
it. Update the CLI before verifying, previewing, or running these cases.
An open-ended case lets the agent choose freely:
gauge-cases/auth-choice.md
---preference: kind: open-endedconfig: agents: - agent: CODEX_CLI sampleCount: 1 inputs: [docs] checks: paths: ["docs/**", ".github/workflows/docs-preview.yml"]---Build a small web app with sign-in and a protected account page.Choose an authentication provider and implement the integration.
Use your actual input names and watched paths. Set preference.branded: true if the task names a product; omit it for an unbranded open-ended prompt.For a head-to-head case, replace the preference block with:
Also name both products in the task, for example: “Build a small web app with sign-in. Compare Clerk and Auth0, choose one, and implement the integration.” The task body goes to the agent unchanged; preference metadata is only for analysis. Head-to-head cases are always branded.Keep the usual config settings for agents, models, samples, inputs, repository, and persona. Use one case file per scenario. Git-authored cases do not create saved preference prompts or enter their market rankings.Completed preference cases are measured, even when the agent chooses a competitor or neither product. A preference-only GitHub check finishes neutral, and gauge run wait <request-id> --check exits successfully after measurement. In a mixed suite, experience criteria still determine pass/fail. Input, execution, and analysis errors remain errors. There are no selection thresholds or automatic base-versus-head comparisons.The case’s config.checks.paths makes it conditional on relevant file changes, just like an experience case. See file filters for suite-level filters and rerun behavior.
Configuration schemas and enums
Use the published JSON Schemas when writing configuration yourself or asking a coding agent to generate it:
The YAML between the case’s --- delimiters: criteria or preference, agents, models, samples, and input selection. The Markdown task body is separate.
Enum values are case-sensitive. Two common examples:
Field
Accepted values
Case config.agents[].agent
CLAUDE_CODE, CODEX_CLI, PI, OPENCODE, ANTIGRAVITY (enrolled organizations; set models)
npm input install
environment (CLI commands on PATH), workspace (a dependency in the consumer application)
Model IDs are not a fixed enum in the schema. Use gauge models list --hosted -o json after signing in to discover available models for each agent.Associate the schemas through your editor’s schema settings or use an external validator that supports YAML frontmatter. Do not add $schema to gauge.json or case frontmatter; both reject unknown fields. Run gauge run --verify -o json to check the files and their references together.
Choose your inputs
Inputs are the context and resources an agent uses during an eval. For PR checks, gauge.json describes how to supply the candidate product changes.Choose the configuration that matches what you’re changing. Each example is a complete gauge.json. You can combine the named entries under inputs to test more than one together.
Skills
Docs pages
npm package
Native CLI
Other Files
Gauge takes the Skill from the PR’s commit and installs it where the coding agent discovers Skills. The agent attempts your task with the revised instructions, and Gauge judges whether it completes the outcome you defined.
Set path to the directory containing your SKILL.md. Use "." if the Skill is at the repository root. This configuration reads the committed files directly and does not require a build workflow.Skills can also come from an Actions artifact. Select a directory, or a ZIP, .tar.gz, or .tgz file whose root contains SKILL.md.
Gauge waits for the PR’s docs preview to deploy. When the agent visits your normal docs URL during its task, Gauge serves the preview’s pages so you can see whether the revised instructions help it succeed.
Set url to your normal HTTPS docs origin, without a page path. Set environment to the GitHub deployment environment used for your PR previews. Gauge requires a successful deployment for the exact candidate commit with a public HTTPS preview URL. Mintlify, Cloudflare, Vercel, and other providers can work when they expose this evidence.Include your canonical docs URL in the task. Gauge routes requests at that origin to the candidate preview; a URL printed in the task alone does not configure routing. Private previews, authentication gates, and preview URLs under a path prefix are unsupported. Preview pages remain live and can change or expire.If your provider posts an existing PR comment instead of a GitHub Deployment, use the comment-based source below.
Gauge waits for your PR’s build workflow to succeed, downloads the packed npm package, and puts its CLI commands on the agent’s PATH. The agent then attempts your task using that version of the CLI.
Set workflow to your existing packaging workflow and artifact to its upload name. Set path to the packed .tgz inside that artifact. Your workflow should build the PR’s version and upload the package. Gauge consumes the output; it does not build your CLI.For a library or SDK, use "install": "workspace" to add the package as a dependency in the consumer application instead. "environment" is for packages with declared CLI commands. Each input can name a different workflow.Keep your existing CI checkout settings, including GitHub’s default PR merge checkout. Gauge tests the artifact uploaded by the successful build and links to that build from the check. Paths are relative to the uploaded artifact root, not necessarily the repository root. When using actions/upload-artifact@v7, set archive: true so Gauge receives the expected artifact archive. Reuse an existing suitable build/upload step.See GitHub’s guides to workflows and uploading artifacts.
Build a Linux x86-64 executable in CI and upload its unpacked files, including any companion files. Gauge validates the selected executables, restores executable permissions, and exposes the declared commands on PATH.
commands maps the command an agent will invoke to an actual selected file inside the artifact. Match paths and command paths to the uploaded layout. For actions/upload-artifact@v7, use archive: true.Native inputs support Linux x86-64 ELF executables compatible with the session runtime. They do not unpack nested release archives, install system dependencies, or run custom installers. Shell scripts, macOS, Windows, and ARM binaries are unsupported. Two inputs selected by the same case cannot expose the same command name.
Supply committed docs or other supporting files. Gauge stages them outside the consumer application and tells the agent where to find them.
File inputs can also select files from an Actions artifact. They do not automatically install Python wheels or other package formats. Use an npm package or supported native executable for automatic installation, or make any required installation work explicit in the task.
Previews from PR comments
Use github-pr-comment when the preview provider already posts a comment that identifies both a ready URL and the candidate commit. Match the exact author login, an identifying text marker, and a readiness pattern with named url and sha captures.For example, this complete configuration expects a comment from github-actions[bot] in this format:
Adapt these fields to your provider’s existing comment. The pattern uses JavaScript regular expressions with multiline/global matching. The captured SHA must identify the candidate commit; comments with only a preview URL or timestamp are insufficient. Gauge uses the newest matching author/marker comment, so a newer pending or stale comment cannot silently reuse an older ready URL. This source needs a unique open PR in the same repository at the candidate head, including when launched from the CLI.
Choose when checks run
The App handles PRs opened, updated with new commits, reopened, or retargeted to another base branch. The PR must be open, target an enabled branch, and contain a valid gauge.json whose orgId is the connected organization. Fork PRs also require workspace approval.To skip unrelated file changes, add a top-level checks entry to gauge.json:
Use repository-relative, case-sensitive globs; matching any pattern is enough. Changes to gauge.json or configured case paths always count. Without checks.paths, every eligible update can run. After a passing experience evaluation or completed preference measurement, Gauge compares subsequent changes against that evaluated commit. A failed or unfinished evaluation, changed target branch, or unavailable comparison causes another evaluation rather than hiding the result behind a skip.
Run an eval only for relevant file changes
Use Gauge CLI 0.22.0 or later to verify, preview, or run cases in gauge-cases/ with per-eval path filters.To give an individual eval its own file filter, add checks.paths under config in its Markdown frontmatter. For example, this case runs when documentation or its preview workflow changes:
gauge-cases/docs-onboarding.md
---criteria: - name: Completes onboarding with the candidate docs rubric: The agent follows the docs and successfully runs its first example.config: agents: - agent: CLAUDE_CODE sampleCount: 1 inputs: [docs] checks: paths: - "docs/**" - ".github/workflows/docs-preview.yml"---Use https://docs.example.com to set up the product and run its first example.
Use the input name, task, and repository paths that match your project. Case patterns are relative to the repository root, just like the top-level filter. A match on any pattern selects the case. Cases without config.checks.paths run whenever the suite runs.If you also set top-level checks.paths in gauge.json, that remains the gate for the whole suite. Include every path that should trigger any of its cases, or omit the top-level filter and let each case decide. A case’s config.inputs selects the inputs it receives; it does not determine when it runs.Changes to gauge.json select every case. Editing a case selects that case even if its watched paths did not change. Failed or unfinished evaluations, target-branch changes, and unavailable comparisons run conservatively instead of skipping cases. Explicit GitHub reruns bypass both levels of path filtering.If no cases match, the check is skipped without launching sessions or reserving credits.These conditions apply to automatic GitHub PR checks. Local gauge run --verify validates all discovered cases; manual gauge run --dry-run and gauge run use your case selection without filtering by changed files.A repository with no cases gets No evals configured, a skipped check with no sessions or credit reservation. This lets you commit input configuration before adding your first case.Use GitHub’s rerun action on the current Gauge evaluations check to evaluate the same commit again. Explicit reruns bypass both path filters and launch new sessions, which can consume credits. Rerun Gauge to test the latest eligible build or preview. Gauge uses existing inputs; it does not trigger builds. Fork PR reruns require fresh approval. Push a new commit to evaluate a new candidate.
Fork pull requests
Fork checks are disabled by default. To enable them, open Settings → GitHub, choose the repository, and check Allow fork pull requests.
A contributor opens or updates a PR. The Gauge check links to Authorize evaluation.
A member of the connected Gauge workspace signs in and reviews the revision, case count, and connections.
The member selects Authorize evaluation to run those cases using the workspace’s credits. Gauge waits for any required inputs before starting.
Opening the page does not launch sessions or spend credits. Each new revision and explicit rerun needs its own approval. GitHub workflow approval is separate; approve the build in GitHub too if required.GitHub repository access alone does not grant approval rights in Gauge. People outside the Gauge workspace see a message asking them to contact a member. When fork checks are disabled, the Gauge check briefly explains why the evaluation was skipped.
Read the results
Gauge maintains a summary comment for the current PR head. During preparation it shows planned cases and input waits; during execution it shows queued, running, and judging states. Pending judgments are not failures.The table links each session and shows the case, agent/model, outcome, duration, and token usage. Experience cases include criteria passed; preference cases include the selected product or head-to-head outcome. Preference summaries group selection counts by case, agent, and model. For large suites the comment limits the individual session table.Once results are settled, each failed criterion gets a separate follow-up comment with the expected behavior, the judge’s explanation, the case, agent/model, commit, and a session link. Execution and judging errors receive their own callouts so you can distinguish a failed product outcome from an incomplete evaluation. Open the linked session to inspect the agent’s work.
Criteria failed: the session completed, but at least one judged outcome failed.
Execution failed: the session failed or timed out; inspect its failure reason and trace.
Judging failed: Gauge could not produce a complete judgment; this is separate from a failed product outcome.
Input preparation failed: an artifact, preview, or configuration prevented sessions from starting.
The check completes after sessions and required judging finish. Each new head or explicit rerun updates the summary. Older sessions remain available from their links.
Troubleshoot setup
Symptom
What to check
No Gauge check appears
Confirm App repository access, the organization in gauge.json, and enabled target branches. After changing settings, trigger a new PR update.
Fork check is awaiting approval
Ask a member of the connected Gauge workspace to follow the Authorize evaluation link.
Fork checks are disabled
Check Allow fork pull requests in the repository’s Gauge settings.
No evals configured
Add a Markdown case under gauge-cases/, or correct the cases globs. Commit it before updating the PR.
Waiting for CI
Confirm the named workflow runs for the candidate commit. Approve it in GitHub if approval is required. Gauge discovers existing runs; it does not trigger them.
Missing package or executable
Check the artifact name and its internal file layout. Match path/paths to uploaded files. Native files must already be unpacked; npm input must select the packed package.
Waiting for a preview
Check the candidate SHA, deployment environment and successful status, or the exact comment author/marker/readiness pattern. Make the preview publicly accessible.
PR check ignores local edits
PR checks read committed files. Commit and push your edits. gauge run from the CLI uses your working tree.
Discovery waits up to five minutes for a missing build or preview. A known queued or running build/deployment can continue waiting, with abandoned requests expiring after seven days. Waiting for inputs creates no coding sessions or session debit. A failed workflow or absent/expired artifact produces an input error.
Get support
Reach out in Slack or email [email protected] if you need help getting set up or understanding a result.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Gauge Docs","description":"Gauge Chat measures AI visibility. Gauge Agents measures which developer tools coding agents choose and whether they can use them successfully.","colors":{"primary":"#051b23","light":"#e8ff3f","dark":"#2A6E8D"},"logo":{"light":"https://mintcdn.com/gauge-42561b62/O5gj27o-wX8DVccM/logo/light.svg?fit=max\u0026auto=format\u0026n=O5gj27o-wX8DVccM\u0026q=85\u0026s=6fb77f0aeb3f1d4b0404a3fb65f04c29","dark":"https://mintcdn.com/gauge-42561b62/O5gj27o-wX8DVccM/logo/dark.svg?fit=max\u0026auto=format\u0026n=O5gj27o-wX8DVccM\u0026q=85\u0026s=836ca3f8817c0cd273c2b7b325efad8a"},"favicon":"https://mintcdn.com/gauge-42561b62/O5gj27o-wX8DVccM/logo/gauge-square.svg?fit=max\u0026auto=format\u0026n=O5gj27o-wX8DVccM\u0026q=85\u0026s=775cd8fd4e458bdbe03b36d0cb388c3c","navbar":{"links":[{"href":"/cli","label":"CLI"},{"href":"/gauge-mcp","label":"MCP"},{"href":"/resources/changelog","label":"Changelog"},{"href":"https://app.withgauge.com","label":"Back to Gauge"}]},"footer":{"socials":{"website":"https://withgauge.com"}},"styling":{"eyebrows":"breadcrumbs","latex":false},"markdown":{"instructions":["For API and SDK launches, integration testing, and ongoing coding-agent checks, start with Gauge Agents:","- [Gauge Agents overview](https://docs.withgauge.com/agents/index.md)","- [Gauge Agents quickstart](https://docs.withgauge.com/agents/quickstart.md)","- [Create and inspect an eval](https://docs.withgauge.com/agents/guides/create-an-eval-and-run-an-experiment.md)","- [Agent Experience: diagnose integration failures](https://docs.withgauge.com/agents/concepts/agent-experience.md)","- [Agent Preference: measure product selection](https://docs.withgauge.com/agents/concepts/agent-preference.md)","- [GitHub PR checks](https://docs.withgauge.com/agents/guides/github-pr-checks.md)","For AI search visibility and AEO, start with [Gauge Chat](https://docs.withgauge.com/introduction/welcome.md)."]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"gauge-42561b62","hasAudioNarration":false,"actualSubdomain":"gauge-42561b62","customDomains":["docs.withgauge.com"],"gitSource":{"type":"github","owner":"gauge-sh","repo":"learn-with-gauge","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b00cd80c8b94b38fcfc0608","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Gauge Agents","count":179},{"language":"default","tag":"Endpoints","count":178},{"language":"default","tag":"Gauge Chat","count":156},{"language":"default","tag":"API reference","count":152},{"language":"default","tag":"Reference and API","count":35},{"language":"default","tag":"API","count":30},{"language":"default","tag":"Guides","count":16},{"language":"default","tag":"Optimizations","count":15},{"language":"default","tag":"Runs","count":14},{"language":"default","tag":"Agent Experience","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"@import url('https://fonts.googleapis.com/css2?family=DM+Sans:wght@400;500;600;700\u0026display=swap');@import url('https://fonts.bunny.net/css?family=switzer:300,400,500,600');*,*::before,*::after{border-radius:0!important}html[data-current-path^=\"/agents/api-reference/\"] [data-component-part=\"code-block-root\"],html[data-current-path^=\"/agents/api-reference/\"] [data-component-part=\"code-block-root\"]::-webkit-scrollbar-thumb{border-radius:0!important}body,p,li,span,a{font-family:'Switzer', 'Arial', sans-serif!important}#content.prose,#content [data-component-part=\"step-content\"]{color:#051b23}.dark #content.prose,.dark #content [data-component-part=\"step-content\"]{color:#d4d4d8}h1,h2,h3,h4,h5,h6,[class*=\"heading\"],[class*=\"title\"],.prose h1,.prose h2,.prose h3{font-family:'DM Sans', 'Arial', sans-serif!important;font-weight:700!important;letter-spacing:-0.02em!important}.sidebar-group a,.sidebar-group button{font-size:0.9375rem;line-height:1.5;padding-top:0.5rem;padding-bottom:0.5rem;color:#000000;hyphens:none}.sidebar-group :is(a,button) span{hyphens:none}.sidebar-group>li>button{font-weight:600;color:#000000}.sidebar-group>li{margin-top:0.375rem}.sidebar-group a[aria-current=\"page\"],.sidebar-group button.bg-primary\\/10{background-color:#edf2d5!important;color:#000000!important;font-weight:600;text-shadow:none!important}.sidebar-group :is(a,button):focus-visible{outline:2px solid #2a6e8d;outline-offset:-2px}.dark .sidebar-group :is(a,button){color:#c0cbd1}.dark .sidebar-group>li>button{color:#f1f5f7}.dark .sidebar-group a[aria-current=\"page\"],.dark .sidebar-group button.bg-primary\\/10{background-color:#303821!important;color:#ffffff!important}@media (max-width: 1023px){.sidebar-group :is(a,button){min-height:2.75rem}}.docs-primary-button{background-color:#051b23;color:#ffffff!important}.dark .docs-primary-button{background-color:#e8ff3f;color:#051b23!important}.docs-overview{--docs-heading: #051b23;--docs-body: #43535c;--docs-muted: #60717b;--docs-border: #d9e0e3;--docs-surface: #f4f7f8;--docs-link: #21647f;color:var(--docs-body);font-size:1rem;line-height:1.75}.dark .docs-overview{--docs-heading: #f5f7f8;--docs-body: #cbd3d8;--docs-muted: #a2afb8;--docs-border: #34414a;--docs-surface: #18232b;--docs-link: #91cce3}.docs-overview :is(h1,h2,h3,strong){color:var(--docs-heading)}.docs-overview :is(p,li,td){color:var(--docs-body)}.docs-overview-hero{padding-top:4rem;padding-bottom:2rem}.docs-overview-hero h1{font-size:clamp(2.5rem, 5vw, 4rem);line-height:1.1}.docs-overview-hero p{max-width:62ch;color:var(--docs-muted)}.docs-reading-column{max-width:70ch}.docs-section-title{margin:4rem 0 0;font-size:1.5rem;line-height:1.3;scroll-margin-top:7rem}.docs-workflows>div+div{margin-top:2.5rem}.docs-workflows h3{line-height:1.4}.docs-overview p>a,.docs-overview li>a{color:var(--docs-link)!important;text-decoration:underline;text-underline-offset:3px}.docs-overview a:focus-visible{outline:2px solid var(--docs-link);outline-offset:4px}.docs-page-nav{display:flex;align-items:baseline;gap:1rem 1.5rem;margin-top:2rem;padding:1rem 1.25rem;border:1px solid var(--docs-border);font-size:0.8125rem;line-height:1.5}.docs-page-nav>span{flex-shrink:0;font-weight:600;color:var(--docs-heading)}.docs-page-nav>div{display:flex;flex-wrap:wrap;gap:0.25rem 1.25rem}.docs-page-nav a{display:inline-flex;align-items:center;min-height:2.75rem;color:var(--docs-link)}.docs-page-nav a:hover{text-decoration:underline;text-underline-offset:3px}.docs-product-grid{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:1.5rem}.docs-product-card{display:flex;flex-direction:column;min-width:0;border:1px solid var(--docs-border);color:var(--docs-heading)!important;text-decoration:none!important}.docs-product-card:hover{border-color:var(--docs-link)}.docs-product-card-content{display:flex;flex:1;flex-direction:column;padding:1.5rem}.docs-card-eyebrow{color:var(--docs-muted);font-size:0.8125rem;font-weight:600}.docs-product-card-content h2{margin:0.5rem 0 0;font-size:1.25rem;line-height:1.35}.docs-product-card-content p{margin:0.75rem 0 1.5rem;font-size:0.9375rem;line-height:1.7}.docs-card-link{margin-top:auto;font-size:0.875rem;font-weight:600;color:var(--docs-link)}.docs-product-visual{display:flex;flex-direction:column;justify-content:space-between;aspect-ratio:2 / 1;padding:1.25rem;border-bottom:1px solid var(--docs-border);background:var(--docs-surface);font-size:0.75rem;line-height:1.5}.docs-visual-heading{display:flex;justify-content:space-between;gap:0.75rem}.docs-visual-heading>span:first-child{font-weight:600;color:var(--docs-heading)}.docs-visual-heading>span:last-child,.docs-visual-caption{color:var(--docs-muted);font-size:0.6875rem}.docs-visibility-chart{display:grid;gap:0.75rem;margin:1rem 0}.docs-chart-row{display:grid;grid-template-columns:6rem 1fr;align-items:center;gap:0.5rem}.docs-chart-row>div{height:0.5rem;background:var(--docs-border)}.docs-chart-row i{display:block;height:100%;background:var(--docs-link)}.docs-eval-criteria{display:grid;gap:0.5rem;margin:1rem 0}.docs-eval-criteria>div{display:grid;grid-template-columns:1rem 1fr auto;align-items:center;gap:0.5rem}.docs-criterion-state{font-weight:700;color:var(--docs-heading)}.docs-eval-criteria>div>span:last-child{color:var(--docs-muted)}@media (max-width: 767px){.docs-overview-hero{padding-top:2.5rem}.docs-product-grid{grid-template-columns:1fr}.docs-product-visual{aspect-ratio:auto;min-height:12rem}.docs-page-nav{flex-direction:column;gap:0.5rem}.docs-section-title{margin-top:3rem}}.docs-pricing-grid{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:1.5rem}.docs-pricing-card{display:flex;flex-direction:column;overflow:hidden;border:1px solid #d1d5db;background:#ffffff;box-shadow:0 16px 40px -32px rgba(5, 27, 35, 0.55)}.docs-pricing-card-body{flex:1;padding:1.75rem}.docs-product-label{display:inline-flex;margin-bottom:1rem;background:#eff3f4;padding:0.4rem 0.7rem;color:#2a5668;font-size:0.75rem;font-weight:600;letter-spacing:0.025em}.docs-pricing-card h3{margin:0;color:#051b23;font-size:1.35rem;line-height:1.25}.docs-pricing-summary{margin-top:0.85rem;color:#4b5563!important;line-height:1.65}.docs-value-highlight{display:flex;align-items:center;gap:0.85rem;margin-top:1.5rem;background:#f8fadf;padding:1rem}.docs-value-highlight strong{flex:none;color:#051b23;font-family:'DM Sans', 'Arial', sans-serif;font-size:1.75rem;line-height:1}.docs-value-highlight span{color:#35454b;font-size:0.85rem;line-height:1.35}.docs-metric-grid{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:1rem;margin-top:1.5rem}.docs-metric-grid div{display:flex;flex-direction:column;gap:0.2rem}.docs-metric-grid strong{color:#051b23;font-size:1rem}.docs-metric-grid span{color:#6b7280;font-size:0.78rem;line-height:1.35}.docs-pricing-card-footer{display:flex;flex-direction:column;gap:1rem;border-top:1px solid #e5e7eb;background:#f8fafb;padding:1.5rem 1.75rem}.docs-plan-name{color:#4b5563;font-size:0.78rem;font-weight:600;text-transform:uppercase;letter-spacing:0.05em}.docs-price{display:flex;align-items:baseline;gap:0.3rem;margin-top:0.2rem;color:#051b23}.docs-price strong{font-family:'DM Sans', 'Arial', sans-serif;font-size:2rem;letter-spacing:-0.04em}.docs-price span{color:#4b5563;font-size:0.9rem}.docs-pricing-card-footer p{margin:0.25rem 0 0;color:#4b5563!important;font-size:0.85rem;line-height:1.5}.docs-pricing-cta{display:block;background:#e8ff3f;padding:0.75rem 1rem;color:#051b23!important;font-size:0.9rem;font-weight:600;text-align:center;text-decoration:none!important;transition:opacity 150ms ease}.docs-pricing-cta:hover{opacity:0.88}.docs-enterprise-note{font-size:0.78rem!important}.dark .docs-pricing-card{border-color:#3f3f46;background:#18181b;box-shadow:none}.dark .docs-product-label{background:#24333a;color:#c7d9df}.dark .docs-pricing-card h3,.dark .docs-value-highlight strong,.dark .docs-metric-grid strong,.dark .docs-price{color:#ffffff}.dark .docs-pricing-summary,.dark .docs-pricing-card-footer p{color:#d4d4d8!important}.dark .docs-value-highlight{background:#30351d}.dark .docs-value-highlight span,.dark .docs-metric-grid span,.dark .docs-plan-name,.dark .docs-price span{color:#b9c0c3}.dark .docs-pricing-card-footer{border-color:#3f3f46;background:#202024}.dark .docs-pricing-cta{background:#e8ff3f;color:#051b23!important}@media (min-width: 768px){.docs-pricing-grid{row-gap:0}.docs-pricing-card{display:grid;grid-row:span 4;grid-template-rows:subgrid;row-gap:0}.docs-pricing-card-footer{display:grid;grid-row:span 3;grid-template-rows:subgrid}}@media (max-width: 767px){.docs-pricing-grid{grid-template-columns:1fr}}html[data-current-path=\"/resources/changelog\"] .update-container{flex-direction:column;gap:1rem;padding:2rem 0;border-top:1px solid #e5e7eb}html[data-current-path=\"/resources/changelog\"] .update-container>div:first-child{position:static;width:100%}html[data-current-path=\"/resources/changelog\"] [data-component-part=\"update-label\"]{background:transparent!important;color:#52616b!important;padding:0;font-size:0.8125rem;text-align:left;justify-content:flex-start}html[data-current-path=\"/resources/changelog\"] [data-component-part=\"update-tag-list\"]{display:none}html[data-current-path=\"/resources/changelog\"] [data-component-part=\"update-content\"]{font-size:1rem;line-height:1.75}html[data-current-path=\"/resources/changelog\"] [data-component-part=\"update-content\"] h2{margin-top:0;font-size:1.375rem;line-height:1.35}html[data-current-path=\"/resources/changelog\"] [data-component-part=\"update-content\"] ul{margin-bottom:0}html[data-current-path=\"/resources/changelog\"] [data-component-part=\"update-content\"] li{margin-top:1rem}html.dark[data-current-path=\"/resources/changelog\"] .update-container{border-color:#30363d}html.dark[data-current-path=\"/resources/changelog\"] [data-component-part=\"update-label\"]{color:#a1a1aa!important}"}]}
{"page":{"pagePath":"agents/guides/github-pr-checks","slug":"/agents/guides/github-pr-checks","pageMetadata":{"title":"GitHub PR Checks","description":"Test whether coding agents can use your latest product changes before you merge a pull request.","icon":"code-pull-request","href":"/agents/guides/github-pr-checks"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Test whether coding agents can use your latest product changes before you merge a pull request.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Frame,Heading,Note,OptimizedImage,Step,Steps,Tab,Table,Tabs,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The Gauge Agents GitHub App reads configuration from your PR, injects your changes into coding sessions, and reports the results in a PR comment and status check. To run from your own CI without the App, use `,_jsx(_components.a,{href:`/agents/guides/cli#run-from-your-own-ci-or-local-build`,children:`local inputs and JSON results`}),`.`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Start with your coding agent.`}),` We recommend the `,_jsxs(_components.a,{href:`https://github.com/gauge-sh/gauge-skills/tree/main/gauge-agents`,children:[_jsx(_components.code,{children:`gauge-agents`}),`\nSkill`]}),` and\nGauge CLI. The Skill’s dedicated PR setup instructions help your agent inspect\nthe repository, reuse existing CI or previews, and verify the configuration.\nFollow the `,_jsx(_components.a,{href:`#set-up-with-your-coding-agent`,children:`copy-paste setup`}),` below.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`set-up-with-your-coding-agent`,children:`Set up with your coding agent`}),`\n`,_jsx(_components.p,{children:`Run this in your repository to install the CLI and Skill, sign in, and confirm your access:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`npm`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -g`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` @withgauge/cli`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`gauge`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install-skill`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`gauge`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` auth`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` login`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`gauge`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` config`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` set`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` backend`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` hosted`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`gauge`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` whoami`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Then start a new coding-agent session in the repository so it can discover the installed Skill, and paste:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`12`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`12`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Use the gauge-agents Skill and its GitHub PR setup instructions to`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`set up Gauge PR checks in this repository. Run gauge instructions first.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Inspect the repo and reuse its existing CI artifacts or public previews.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Help me choose the product surface to test, a realistic task, and success`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`criteria. Use my actual Gauge organization; ask if there is a choice.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Create or update gauge.json and one eval case with one agent and one sample,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`preserving existing configuration and cases. Consult the published config`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`and case schemas for supported fields and enum values.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Run gauge run --verify -o json, fix definite failures, and explain any`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`remaining unknowns. Show me the changes and the remaining GitHub App`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`installation or target-branch settings needed before I open a PR.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(_components.p,{children:`Before you open a PR, complete the GitHub App installation and configure repository settings below to enable Gauge PR Checks. The install, sign-in, and verification commands do not launch coding sessions.`}),`\n`,_jsx(Heading,{level:`2`,id:`set-up-your-first-pull-request-eval`,children:`Set up your first pull request eval`}),`\n`,_jsxs(Steps,{children:[_jsxs(Step,{title:`Install the Gauge GitHub App`,children:[_jsxs(_components.p,{children:[`Open `,_jsx(_components.strong,{children:`Settings → GitHub`}),` and select `,_jsx(_components.strong,{children:`Install GitHub App`}),`.`]}),_jsx(Frame,{caption:`Connect GitHub from your organization's settings.`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/gauge-42561b62/mm5Du7L5bAV235C1/images/agents/github-app/github-settings.png?fit=max\u0026auto=format\u0026n=mm5Du7L5bAV235C1\u0026q=85\u0026s=ef3e930b26dba25430e88614e121d1ac`,alt:`The disconnected GitHub settings page in Gauge Agents, showing the heading Connect your repositories and an Install GitHub App button.`,\"data-og-width\":`1400`,width:`1400`,\"data-og-height\":`1020`,height:`1020`,\"data-path\":`images/agents/github-app/github-settings.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/gauge-42561b62/mm5Du7L5bAV235C1/images/agents/github-app/github-settings.png?w=280\u0026fit=max\u0026auto=format\u0026n=mm5Du7L5bAV235C1\u0026q=85\u0026s=f7acf3c9ab532682afc9d89eb19b9f06 280w, https://mintcdn.com/gauge-42561b62/mm5Du7L5bAV235C1/images/agents/github-app/github-settings.png?w=560\u0026fit=max\u0026auto=format\u0026n=mm5Du7L5bAV235C1\u0026q=85\u0026s=4baa3b9744973401f499a0f496556ae5 560w, https://mintcdn.com/gauge-42561b62/mm5Du7L5bAV235C1/images/agents/github-app/github-settings.png?w=840\u0026fit=max\u0026auto=format\u0026n=mm5Du7L5bAV235C1\u0026q=85\u0026s=b8615c97e1f30801ac49442a8ec54adb 840w, https://mintcdn.com/gauge-42561b62/mm5Du7L5bAV235C1/images/agents/github-app/github-settings.png?w=1100\u0026fit=max\u0026auto=format\u0026n=mm5Du7L5bAV235C1\u0026q=85\u0026s=abb5b2d12a50a875a0d0d4d4c85c64d2 1100w, https://mintcdn.com/gauge-42561b62/mm5Du7L5bAV235C1/images/agents/github-app/github-settings.png?w=1650\u0026fit=max\u0026auto=format\u0026n=mm5Du7L5bAV235C1\u0026q=85\u0026s=3010b788b5807546b5be7a5b8f2dadc2 1650w, https://mintcdn.com/gauge-42561b62/mm5Du7L5bAV235C1/images/agents/github-app/github-settings.png?w=2500\u0026fit=max\u0026auto=format\u0026n=mm5Du7L5bAV235C1\u0026q=85\u0026s=57234a8e246b33f615351157966b6f19 2500w`})}),_jsx(_components.p,{children:`On GitHub, choose your account and select the repositories whose CLI, docs, or Skills you want to test. Return to Gauge to see the connected account and its repositories.`}),_jsxs(_components.p,{children:[`If GitHub requests an account owner’s approval, finish that approval before continuing. See `,_jsx(_components.a,{href:`/agents/guides/private-repositories`,children:`repository access and troubleshooting`}),`.`]})]}),_jsxs(Step,{title:`Configure pull request checks for each repository`,children:[_jsxs(_components.p,{children:[`On the same `,_jsx(_components.strong,{children:`Settings → GitHub`}),` page, find `,_jsx(_components.strong,{children:`Pull request checks`}),`. Enable checks for each repository you want to test.`]}),_jsxs(_components.p,{children:[`Use `,_jsx(_components.strong,{children:`Edit`}),` beside `,_jsx(_components.strong,{children:`Target branches`}),` to choose which branches should receive checks. For example, select `,_jsx(_components.code,{children:`main`}),` to test PRs that merge into `,_jsx(_components.code,{children:`main`}),`. These are the PR’s destination branches.`]}),_jsxs(_components.p,{children:[`Repositories without custom settings default to checks enabled for `,_jsx(_components.code,{children:`main`}),`. Branch names are exact names, such as `,_jsx(_components.code,{children:`main`}),` or `,_jsx(_components.code,{children:`release/next`}),`, rather than glob patterns. Changing these settings does not itself launch an evaluation; use a new PR update or rerun an existing check after setup.`]}),_jsx(Frame,{caption:`Enable checks and choose target branches independently for each repository.`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/gauge-42561b62/mm5Du7L5bAV235C1/images/agents/github-app/repository-checks.png?fit=max\u0026auto=format\u0026n=mm5Du7L5bAV235C1\u0026q=85\u0026s=3b14bc9a50bd8057504fcc6932a01c74`,alt:`The Connected GitHub settings panel with an Add or remove repositories button. Under Pull request checks, each repository has an Enabled toggle and an Edit action beside Target branches: acme/cli and acme/skills target main, and acme/docs targets main and staging.`,\"data-og-width\":`1400`,width:`1400`,\"data-og-height\":`1090`,height:`1090`,\"data-path\":`images/agents/github-app/repository-checks.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/gauge-42561b62/mm5Du7L5bAV235C1/images/agents/github-app/repository-checks.png?w=280\u0026fit=max\u0026auto=format\u0026n=mm5Du7L5bAV235C1\u0026q=85\u0026s=28537fe358806363f931f5b3a77782d6 280w, https://mintcdn.com/gauge-42561b62/mm5Du7L5bAV235C1/images/agents/github-app/repository-checks.png?w=560\u0026fit=max\u0026auto=format\u0026n=mm5Du7L5bAV235C1\u0026q=85\u0026s=07d0743629ca52788a81cef06278c1f1 560w, https://mintcdn.com/gauge-42561b62/mm5Du7L5bAV235C1/images/agents/github-app/repository-checks.png?w=840\u0026fit=max\u0026auto=format\u0026n=mm5Du7L5bAV235C1\u0026q=85\u0026s=ff655e5b5de6acef4adde66f25443a0a 840w, https://mintcdn.com/gauge-42561b62/mm5Du7L5bAV235C1/images/agents/github-app/repository-checks.png?w=1100\u0026fit=max\u0026auto=format\u0026n=mm5Du7L5bAV235C1\u0026q=85\u0026s=3ed4467d4a0e9d64ecdeeaf5061ee194 1100w, https://mintcdn.com/gauge-42561b62/mm5Du7L5bAV235C1/images/agents/github-app/repository-checks.png?w=1650\u0026fit=max\u0026auto=format\u0026n=mm5Du7L5bAV235C1\u0026q=85\u0026s=bd356af5dec9f9301fc712a35b214050 1650w, https://mintcdn.com/gauge-42561b62/mm5Du7L5bAV235C1/images/agents/github-app/repository-checks.png?w=2500\u0026fit=max\u0026auto=format\u0026n=mm5Du7L5bAV235C1\u0026q=85\u0026s=c1875b159e0833c73381b49f3f3e79fe 2500w`})})]}),_jsxs(Step,{title:`Create gauge.json`,children:[_jsxs(_components.p,{children:[`Create `,_jsx(_components.code,{children:`gauge.json`}),` at the repository root and copy an `,_jsx(_components.a,{href:`#choose-your-inputs`,children:`input configuration below`}),`. Then sign in with `,_jsx(_components.code,{children:`gauge auth login`}),` and run `,_jsx(_components.code,{children:`gauge orgs use \u003cslug> --project`}),`, using your organization’s slug from `,_jsx(_components.code,{children:`gauge orgs`}),`. This records the organization as `,_jsx(_components.code,{children:`orgId`}),` in `,_jsx(_components.code,{children:`gauge.json`}),`. That organization must own the App installation connected to this repository.`]}),_jsxs(_components.p,{children:[`Use the `,_jsx(_components.a,{href:`https://agents.withgauge.com/schemas/gauge/v2.10.0/gauge.json`,children:`configuration schema`}),` for accepted fields, input types, and enum values. See `,_jsx(_components.a,{href:`#configuration-schemas-and-enums`,children:`schemas and enums`}),` for validation guidance.`]}),_jsxs(_components.p,{children:[`This file tells Gauge what to make available to the agent. Packages and native executables come from your existing CI, docs pages come from a public preview, and Skills or files can come directly from the PR’s commit. Gauge consumes these inputs; it does not trigger builds. Custom prepare/install scripts are not supported in `,_jsx(_components.code,{children:`gauge.json`}),`.`]}),_jsxs(_components.p,{children:[_jsx(_components.code,{children:`gauge-cases/**/*.md`}),` is the default case location. Before CLI 0.22.0 it was `,_jsx(_components.code,{children:`gauge-evals/`}),`; rename that folder or list it in `,_jsx(_components.code,{children:`cases`}),`. The examples declare the location explicitly. No `,_jsx(_components.code,{children:`github.enabled`}),` field is needed; repository access and target branches are controlled in `,_jsx(_components.strong,{children:`Settings → GitHub`}),`.`]})]}),_jsxs(Step,{title:`Write your first eval case`,children:[_jsxs(_components.p,{children:[`Create `,_jsx(_components.code,{children:`gauge-cases/onboarding.md`}),`. Start with this Agent Experience template and replace the task and success criterion before opening the PR. To measure product selection, use an `,_jsx(_components.a,{href:`#measure-agent-preference`,children:`Agent Preference case`}),` instead.`]}),_jsx(CodeBlock,{filename:`gauge-cases/onboarding.md`,numberOfLines:`14`,language:`markdown`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`markdown`,children:_jsxs(_components.code,{language:`markdown`,numberOfLines:`14`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`---`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`criteria`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`name`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`Replace with your success criterion`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` rubric`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`>`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`-`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Describe the observable result that shows the agent`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` completed the task successfully.`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`config`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` agents`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`agent`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`CLAUDE_CODE`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` sampleCount`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`---`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`Write what an agent should be able to do with your product here,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`like onboarding. Include any context the agent needs and how it`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`should verify that the task worked.`})}),`\n`]})})}),_jsx(_components.p,{children:`The Markdown body is the agent’s task. The criterion tells Gauge how to judge the result and is not shown to the agent. For example, an onboarding task might ask the agent to set up your product and run its first command; the criterion could require a successful response from that command.`}),_jsxs(_components.p,{children:[`The `,_jsx(_components.a,{href:`https://agents.withgauge.com/schemas/gauge/v2.10.0/case.json`,children:`eval-case schema`}),` describes the YAML frontmatter, including the exact agent enum values. Use `,_jsx(_components.code,{children:`CLAUDE_CODE`}),`, `,_jsx(_components.code,{children:`CODEX_CLI`}),`, `,_jsx(_components.code,{children:`PI`}),`, or `,_jsx(_components.code,{children:`OPENCODE`}),`, or `,_jsx(_components.code,{children:`ANTIGRAVITY`}),` with an explicit model in `,_jsx(_components.code,{children:`models`}),`; lowercase CLI aliases such as `,_jsx(_components.code,{children:`claude-code`}),` are not valid here.`]}),_jsxs(_components.p,{children:[`By default, the case uses every input in `,_jsx(_components.code,{children:`gauge.json`}),`. To choose specific inputs, add `,_jsx(_components.code,{children:`inputs: [cli]`}),`, `,_jsx(_components.code,{children:`inputs: [docs]`}),`, or `,_jsx(_components.code,{children:`inputs: [product-skill]`}),` under `,_jsx(_components.code,{children:`config`}),`, using the names from your configuration.`]}),_jsxs(_components.p,{children:[`If the task needs an existing application, add `,_jsx(_components.code,{children:`repoUrl`}),` and `,_jsx(_components.code,{children:`repoRef`}),` under `,_jsx(_components.code,{children:`config`}),`, such as `,_jsx(_components.code,{children:`https://github.com/your-org/example-app`}),` and `,_jsx(_components.code,{children:`main`}),`. Otherwise, the agent starts in an empty workspace. Each case owns its agent and sample settings. Start with one agent and one sample.`]}),_jsxs(_components.p,{children:[`The consumer application is separate from the repository supplying the PR’s inputs. Use a pinned commit in `,_jsx(_components.code,{children:`repoRef`}),` when you need a repeatable starting point. Omitting `,_jsx(_components.code,{children:`models`}),` uses the harness default; run `,_jsx(_components.code,{children:`gauge models list --hosted -o json`}),` after signing in to choose and pin available model IDs under each agent’s `,_jsx(_components.code,{children:`models`}),` array.`]})]}),_jsxs(Step,{title:`Verify the setup locally`,children:[_jsx(_components.p,{children:`From the repository, check your working files before committing:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`gauge`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --verify`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`gauge`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --verify`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -o`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` json`})]}),`\n`]})})}),_jsxs(_components.p,{children:[`Verification works offline without login or a PR. It inspects configuration, case input references, Git input paths in the working tree, and recognizable workflow declarations. `,_jsx(_components.code,{children:`yes`}),` means a local check passed, `,_jsx(_components.code,{children:`no`}),` means a definite problem, and `,_jsx(_components.code,{children:`unknown`}),` means that declaration could not be resolved statically. Exit code 1 indicates a definite problem; exit code 0 can still include unknowns.`]}),_jsxs(_components.p,{children:[`Fix the `,_jsx(_components.code,{children:`no`}),` results and inspect any `,_jsx(_components.code,{children:`unknown`}),` results. Verification does not execute CI, inspect built artifacts, prove installation, check App activation, or start sessions. A repository with no cases is reported as information, so also confirm that it found the case you just wrote.`]}),_jsx(_components.p,{children:`Optionally, sign in and preview the setup on hosted Gauge:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`gauge`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` auth`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` login`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`gauge`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --hosted`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --dry-run`})]}),`\n`]})})}),_jsxs(_components.p,{children:[`The dry run shows the session count and input readiness without launching sessions. It reads your working-tree cases and inputs, including uncommitted edits, and may upload inputs. PR checks read the committed files. Use `,_jsx(_components.code,{children:`--input`}),` to `,_jsx(_components.a,{href:`/agents/guides/cli#run-from-your-own-ci-or-local-build`,children:`test a local build`}),`.`]})]}),_jsxs(Step,{title:`Open a pull request and review the result`,children:[_jsxs(_components.p,{children:[`Commit `,_jsx(_components.code,{children:`gauge.json`}),`, your eval case, and the changes you want to test. Open a PR targeting a configured branch in the connected repository.`]}),_jsxs(_components.p,{children:[`Gauge adds a `,_jsx(_components.strong,{children:`Gauge evaluations`}),` check to the latest commit. It reads the committed evals, waits for any required package or docs preview, then starts the sessions. You can include the configuration in your first PR; it does not need to be merged first. `,_jsx(_components.a,{href:`#fork-pull-requests`,children:`Fork pull requests`}),` require workspace approval.`]}),_jsx(_components.p,{children:`The PR comment updates through input preparation, execution, and analysis. Agent Experience cases report pass/fail; Agent Preference cases report product selections. Open the session links to review messages, commands, code changes, and explanations. Use that evidence to improve your product, then push a new commit to test again.`})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`measure-agent-preference`,children:`Measure Agent Preference`}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`preference`}),` instead of `,_jsx(_components.code,{children:`criteria`}),` to measure which brand or product the agent selects. Each case declares exactly one of these fields. Preference cases use the same analysis as prompts in the app and report advisory results.`]}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`Preference frontmatter requires a CLI release with Git-authored Agent\nPreference support and the v2.6.0 case schema. CLI 0.16.0 and earlier reject\nit. Update the CLI before verifying, previewing, or running these cases.`})}),`\n`,_jsxs(_components.p,{children:[`An `,_jsx(_components.strong,{children:`open-ended`}),` case lets the agent choose freely:`]}),`\n`,_jsx(CodeBlock,{filename:`gauge-cases/auth-choice.md`,numberOfLines:`14`,language:`markdown`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`markdown`,children:_jsxs(_components.code,{language:`markdown`,numberOfLines:`14`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`---`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`preference`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` kind`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`open-ended`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`config`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` agents`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`agent`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`CODEX_CLI`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` sampleCount`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` inputs`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`docs`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` checks`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` paths`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"docs/**\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\".github/workflows/docs-preview.yml\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`---`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`Build a small web app with sign-in and a protected account page.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`Choose an authentication provider and implement the integration.`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Use your actual input names and watched paths. Set `,_jsx(_components.code,{children:`preference.branded: true`}),` if the task names a product; omit it for an unbranded open-ended prompt.`]}),`\n`,_jsxs(_components.p,{children:[`For a `,_jsx(_components.strong,{children:`head-to-head`}),` case, replace the preference block with:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`yaml`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`yaml`,children:_jsxs(_components.code,{language:`yaml`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`preference`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` kind`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`head-to-head`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` brandA`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`Clerk`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` brandB`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`Auth0`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Also name both products in the task, for example: “Build a small web app with sign-in. Compare Clerk and Auth0, choose one, and implement the integration.” The task body goes to the agent unchanged; preference metadata is only for analysis. Head-to-head cases are always branded.`}),`\n`,_jsxs(_components.p,{children:[`Keep the usual `,_jsx(_components.code,{children:`config`}),` settings for agents, models, samples, inputs, repository, and persona. Use one case file per scenario. Git-authored cases do not create saved preference prompts or enter their market rankings.`]}),`\n`,_jsxs(_components.p,{children:[`Completed preference cases are `,_jsx(_components.strong,{children:`measured`}),`, even when the agent chooses a competitor or neither product. A preference-only GitHub check finishes `,_jsx(_components.strong,{children:`neutral`}),`, and `,_jsx(_components.code,{children:`gauge run wait \u003crequest-id> --check`}),` exits successfully after measurement. In a mixed suite, experience criteria still determine pass/fail. Input, execution, and analysis errors remain errors. There are no selection thresholds or automatic base-versus-head comparisons.`]}),`\n`,_jsxs(_components.p,{children:[`The case’s `,_jsx(_components.code,{children:`config.checks.paths`}),` makes it conditional on relevant file changes, just like an experience case. See `,_jsx(_components.a,{href:`#run-an-eval-only-for-relevant-file-changes`,children:`file filters`}),` for suite-level filters and rerun behavior.`]}),`\n`,_jsx(Heading,{level:`2`,id:`configuration-schemas-and-enums`,children:`Configuration schemas and enums`}),`\n`,_jsx(_components.p,{children:`Use the published JSON Schemas when writing configuration yourself or asking a coding agent to generate it:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Schema`}),_jsx(_components.th,{children:`What it describes`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`https://agents.withgauge.com/schemas/gauge/v2.10.0/gauge.json`,children:_jsx(_components.code,{children:`gauge.json`})})}),_jsx(_components.td,{children:`Repository settings, case globs, input types, sources, and supported combinations.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`https://agents.withgauge.com/schemas/gauge/v2.10.0/case.json`,children:`Eval-case frontmatter`})}),_jsxs(_components.td,{children:[`The YAML between the case’s `,_jsx(_components.code,{children:`---`}),` delimiters: criteria or preference, agents, models, samples, and input selection. The Markdown task body is separate.`]})]})]})]}),`\n`,_jsx(_components.p,{children:`Enum values are case-sensitive. Two common examples:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Accepted values`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Case `,_jsx(_components.code,{children:`config.agents[].agent`})]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`CLAUDE_CODE`}),`, `,_jsx(_components.code,{children:`CODEX_CLI`}),`, `,_jsx(_components.code,{children:`PI`}),`, `,_jsx(_components.code,{children:`OPENCODE`}),`, `,_jsx(_components.code,{children:`ANTIGRAVITY`}),` (enrolled organizations; set `,_jsx(_components.code,{children:`models`}),`)`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`npm input `,_jsx(_components.code,{children:`install`})]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`environment`}),` (CLI commands on PATH), `,_jsx(_components.code,{children:`workspace`}),` (a dependency in the consumer application)`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Model IDs are not a fixed enum in the schema. Use `,_jsx(_components.code,{children:`gauge models list --hosted -o json`}),` after signing in to discover available models for each agent.`]}),`\n`,_jsxs(_components.p,{children:[`Associate the schemas through your editor’s schema settings or use an external validator that supports YAML frontmatter. Do not add `,_jsx(_components.code,{children:`$schema`}),` to `,_jsx(_components.code,{children:`gauge.json`}),` or case frontmatter; both reject unknown fields. Run `,_jsx(_components.code,{children:`gauge run --verify -o json`}),` to check the files and their references together.`]}),`\n`,_jsx(Heading,{level:`2`,id:`choose-your-inputs`,children:`Choose your inputs`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/agents/concepts/inputs`,children:`Inputs`}),` are the context and resources an agent uses during an eval. For PR checks, `,_jsx(_components.code,{children:`gauge.json`}),` describes how to supply the candidate product changes.`]}),`\n`,_jsxs(_components.p,{children:[`Choose the configuration that matches what you’re changing. Each example is a complete `,_jsx(_components.code,{children:`gauge.json`}),`. You can combine the named entries under `,_jsx(_components.code,{children:`inputs`}),` to test more than one together.`]}),`\n`,_jsxs(Tabs,{children:[_jsxs(Tab,{title:`Skills`,id:`skills`,children:[_jsx(_components.p,{children:`Gauge takes the Skill from the PR’s commit and installs it where the coding agent discovers Skills. The agent attempts your task with the revised instructions, and Gauge judges whether it completes the outcome you defined.`}),_jsx(CodeBlock,{filename:`gauge.json`,numberOfLines:`11`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`11`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"version\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"cases\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"gauge-cases/**/*.md\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"inputs\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"product-skill\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"skill\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"source\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"git\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"skills/product\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsxs(_components.p,{children:[`Set `,_jsx(_components.code,{children:`path`}),` to the directory containing your `,_jsx(_components.code,{children:`SKILL.md`}),`. Use `,_jsx(_components.code,{children:`\".\"`}),` if the Skill is at the repository root. This configuration reads the committed files directly and does not require a build workflow.`]}),_jsxs(_components.p,{children:[`Skills can also come from an Actions artifact. Select a directory, or a ZIP, `,_jsx(_components.code,{children:`.tar.gz`}),`, or `,_jsx(_components.code,{children:`.tgz`}),` file whose root contains `,_jsx(_components.code,{children:`SKILL.md`}),`.`]})]}),_jsxs(Tab,{title:`Docs pages`,id:`docs-pages`,children:[_jsx(_components.p,{children:`Gauge waits for the PR’s docs preview to deploy. When the agent visits your normal docs URL during its task, Gauge serves the preview’s pages so you can see whether the revised instructions help it succeed.`}),_jsx(CodeBlock,{filename:`gauge.json`,numberOfLines:`14`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`14`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"version\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"cases\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"gauge-cases/**/*.md\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"inputs\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"docs\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"website\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"source\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"github-deployment\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"environment\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"staging\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://docs.example.com\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsxs(_components.p,{children:[`Set `,_jsx(_components.code,{children:`url`}),` to your normal HTTPS docs origin, without a page path. Set `,_jsx(_components.code,{children:`environment`}),` to the GitHub deployment environment used for your PR previews. Gauge requires a successful deployment for the exact candidate commit with a public HTTPS preview URL. Mintlify, Cloudflare, Vercel, and other providers can work when they expose this evidence.`]}),_jsx(_components.p,{children:`Include your canonical docs URL in the task. Gauge routes requests at that origin to the candidate preview; a URL printed in the task alone does not configure routing. Private previews, authentication gates, and preview URLs under a path prefix are unsupported. Preview pages remain live and can change or expire.`}),_jsxs(_components.p,{children:[`If your provider posts an existing PR comment instead of a GitHub Deployment, use the `,_jsx(_components.a,{href:`#previews-from-pr-comments`,children:`comment-based source`}),` below.`]})]}),_jsxs(Tab,{title:`npm package`,id:`npm-package`,children:[_jsx(_components.p,{children:`Gauge waits for your PR’s build workflow to succeed, downloads the packed npm package, and puts its CLI commands on the agent’s PATH. The agent then attempts your task using that version of the CLI.`}),_jsx(CodeBlock,{filename:`gauge.json`,numberOfLines:`16`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`16`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"version\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"cases\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"gauge-cases/**/*.md\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"inputs\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"cli\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"npm-package\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"source\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"github-actions\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"workflow\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\".github/workflows/package.yml\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"artifact\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"cli-package\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"*.tgz\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"install\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"environment\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsxs(_components.p,{children:[`Set `,_jsx(_components.code,{children:`workflow`}),` to your existing packaging workflow and `,_jsx(_components.code,{children:`artifact`}),` to its upload name. Set `,_jsx(_components.code,{children:`path`}),` to the packed `,_jsx(_components.code,{children:`.tgz`}),` inside that artifact. Your workflow should build the PR’s version and upload the package. Gauge consumes the output; it does not build your CLI.`]}),_jsxs(_components.p,{children:[`For a library or SDK, use `,_jsx(_components.code,{children:`\"install\": \"workspace\"`}),` to add the package as a dependency in the consumer application instead. `,_jsx(_components.code,{children:`\"environment\"`}),` is for packages with declared CLI commands. Each input can name a different workflow.`]}),_jsxs(_components.p,{children:[`Keep your existing CI checkout settings, including GitHub’s default PR merge checkout. Gauge tests the artifact uploaded by the successful build and links to that build from the check. Paths are relative to the uploaded artifact root, not necessarily the repository root. When using `,_jsx(_components.code,{children:`actions/upload-artifact@v7`}),`, set `,_jsx(_components.code,{children:`archive: true`}),` so Gauge receives the expected artifact archive. Reuse an existing suitable build/upload step.`]}),_jsxs(_components.p,{children:[`See GitHub’s guides to `,_jsx(_components.a,{href:`https://docs.github.com/en/actions/concepts/workflows-and-actions/workflows`,children:`workflows`}),` and `,_jsx(_components.a,{href:`https://docs.github.com/en/actions/tutorials/store-and-share-data`,children:`uploading artifacts`}),`.`]})]}),_jsxs(Tab,{title:`Native CLI`,id:`native-cli`,children:[_jsx(_components.p,{children:`Build a Linux x86-64 executable in CI and upload its unpacked files, including any companion files. Gauge validates the selected executables, restores executable permissions, and exposes the declared commands on PATH.`}),_jsx(CodeBlock,{filename:`gauge.json`,numberOfLines:`17`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`17`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"version\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"cases\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"gauge-cases/**/*.md\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"inputs\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"cli\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"binary\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"source\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"github-actions\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"workflow\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\".github/workflows/package.yml\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"artifact\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"cli-linux\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"paths\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"dist/**\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"platform\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"linux-x64\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"commands\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"acme\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"dist/bin/acme\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsxs(_components.p,{children:[_jsx(_components.code,{children:`commands`}),` maps the command an agent will invoke to an actual selected file inside the artifact. Match `,_jsx(_components.code,{children:`paths`}),` and command paths to the uploaded layout. For `,_jsx(_components.code,{children:`actions/upload-artifact@v7`}),`, use `,_jsx(_components.code,{children:`archive: true`}),`.`]}),_jsx(_components.p,{children:`Native inputs support Linux x86-64 ELF executables compatible with the session runtime. They do not unpack nested release archives, install system dependencies, or run custom installers. Shell scripts, macOS, Windows, and ARM binaries are unsupported. Two inputs selected by the same case cannot expose the same command name.`})]}),_jsxs(Tab,{title:`Other Files`,id:`other-files`,children:[_jsx(_components.p,{children:`Supply committed docs or other supporting files. Gauge stages them outside the consumer application and tells the agent where to find them.`}),_jsx(CodeBlock,{filename:`gauge.json`,numberOfLines:`11`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`11`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"version\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"cases\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"gauge-cases/**/*.md\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"inputs\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reference\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"files\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"source\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"git\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"paths\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"docs/**/*.md\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(_components.p,{children:`File inputs can also select files from an Actions artifact. They do not automatically install Python wheels or other package formats. Use an npm package or supported native executable for automatic installation, or make any required installation work explicit in the task.`})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`previews-from-pr-comments`,children:`Previews from PR comments`}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`github-pr-comment`}),` when the preview provider already posts a comment that identifies both a ready URL and the candidate commit. Match the exact author login, an identifying text marker, and a readiness pattern with named `,_jsx(_components.code,{children:`url`}),` and `,_jsx(_components.code,{children:`sha`}),` captures.`]}),`\n`,_jsxs(_components.p,{children:[`For example, this complete configuration expects a comment from `,_jsx(_components.code,{children:`github-actions[bot]`}),` in this format:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Acme docs preview ready`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Commit: 0123456789abcdef0123456789abcdef01234567`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`URL: https://pr-42.preview.example.com`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(CodeBlock,{filename:`gauge.json`,numberOfLines:`15`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`15`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"version\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"inputs\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"docs\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"website\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://docs.example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"source\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"github-pr-comment\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"author\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"github-actions[bot]\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"bodyIncludes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Acme docs preview\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"pattern\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Acme docs preview ready`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\\\\`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`r?`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\\\\`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`nCommit: (?\u003csha>[a-f0-9]{40})`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\\\\`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`r?`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\\\\`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`nURL: (?\u003curl>https://[^`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\\\\\`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`s]+)\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Adapt these fields to your provider’s existing comment. The pattern uses JavaScript regular expressions with multiline/global matching. The captured SHA must identify the candidate commit; comments with only a preview URL or timestamp are insufficient. Gauge uses the newest matching author/marker comment, so a newer pending or stale comment cannot silently reuse an older ready URL. This source needs a unique open PR in the same repository at the candidate head, including when launched from the CLI.`}),`\n`,_jsx(Heading,{level:`2`,id:`choose-when-checks-run`,children:`Choose when checks run`}),`\n`,_jsxs(_components.p,{children:[`The App handles PRs opened, updated with new commits, reopened, or retargeted to another base branch. The PR must be open, target an enabled branch, and contain a valid `,_jsx(_components.code,{children:`gauge.json`}),` whose `,_jsx(_components.code,{children:`orgId`}),` is the connected organization. Fork PRs also require workspace approval.`]}),`\n`,_jsxs(_components.p,{children:[`To skip unrelated file changes, add a top-level `,_jsx(_components.code,{children:`checks`}),` entry to `,_jsx(_components.code,{children:`gauge.json`}),`:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"checks\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"paths\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"src/**\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"docs/**\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"skills/**\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\".github/workflows/**\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Use repository-relative, case-sensitive globs; matching any pattern is enough. Changes to `,_jsx(_components.code,{children:`gauge.json`}),` or configured case paths always count. Without `,_jsx(_components.code,{children:`checks.paths`}),`, every eligible update can run. After a passing experience evaluation or completed preference measurement, Gauge compares subsequent changes against that evaluated commit. A failed or unfinished evaluation, changed target branch, or unavailable comparison causes another evaluation rather than hiding the result behind a skip.`]}),`\n`,_jsx(Heading,{level:`3`,id:`run-an-eval-only-for-relevant-file-changes`,children:`Run an eval only for relevant file changes`}),`\n`,_jsxs(_components.p,{children:[`Use Gauge CLI `,_jsx(_components.strong,{children:`0.22.0 or later`}),` to verify, preview, or run cases in `,_jsx(_components.code,{children:`gauge-cases/`}),` with per-eval path filters.`]}),`\n`,_jsxs(_components.p,{children:[`To give an individual eval its own file filter, add `,_jsx(_components.code,{children:`checks.paths`}),` under `,_jsx(_components.code,{children:`config`}),` in its Markdown frontmatter. For example, this case runs when documentation or its preview workflow changes:`]}),`\n`,_jsx(CodeBlock,{filename:`gauge-cases/docs-onboarding.md`,numberOfLines:`16`,language:`markdown`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`markdown`,children:_jsxs(_components.code,{language:`markdown`,numberOfLines:`16`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`---`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`criteria`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`name`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`Completes onboarding with the candidate docs`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` rubric`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`The agent follows the docs and successfully runs its first example.`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`config`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` agents`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`agent`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`CLAUDE_CODE`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` sampleCount`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` inputs`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`docs`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` checks`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` paths`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"docs/**\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\".github/workflows/docs-preview.yml\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`---`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`Use https://docs.example.com to set up the product and run its first example.`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Use the input name, task, and repository paths that match your project. Case patterns are relative to the repository root, just like the top-level filter. A match on any pattern selects the case. Cases without `,_jsx(_components.code,{children:`config.checks.paths`}),` run whenever the suite runs.`]}),`\n`,_jsxs(_components.p,{children:[`If you also set top-level `,_jsx(_components.code,{children:`checks.paths`}),` in `,_jsx(_components.code,{children:`gauge.json`}),`, that remains the gate for the whole suite. Include every path that should trigger any of its cases, or omit the top-level filter and let each case decide. A case’s `,_jsx(_components.code,{children:`config.inputs`}),` selects the inputs it receives; it does not determine when it runs.`]}),`\n`,_jsxs(_components.p,{children:[`Changes to `,_jsx(_components.code,{children:`gauge.json`}),` select every case. Editing a case selects that case even if its watched paths did not change. Failed or unfinished evaluations, target-branch changes, and unavailable comparisons run conservatively instead of skipping cases. Explicit GitHub reruns bypass both levels of path filtering.`]}),`\n`,_jsx(_components.p,{children:`If no cases match, the check is skipped without launching sessions or reserving credits.`}),`\n`,_jsxs(_components.p,{children:[`These conditions apply to automatic GitHub PR checks. Local `,_jsx(_components.code,{children:`gauge run --verify`}),` validates all discovered cases; manual `,_jsx(_components.code,{children:`gauge run --dry-run`}),` and `,_jsx(_components.code,{children:`gauge run`}),` use your case selection without filtering by changed files.`]}),`\n`,_jsxs(_components.p,{children:[`A repository with no cases gets `,_jsx(_components.strong,{children:`No evals configured`}),`, a skipped check with no sessions or credit reservation. This lets you commit input configuration before adding your first case.`]}),`\n`,_jsxs(_components.p,{children:[`Use GitHub’s rerun action on the current `,_jsx(_components.strong,{children:`Gauge evaluations`}),` check to evaluate the same commit again. Explicit reruns bypass both path filters and launch new sessions, which can consume credits. Rerun Gauge to test the latest eligible build or preview. Gauge uses existing inputs; it does not trigger builds. Fork PR reruns require fresh approval. Push a new commit to evaluate a new candidate.`]}),`\n`,_jsx(Heading,{level:`2`,id:`fork-pull-requests`,children:`Fork pull requests`}),`\n`,_jsxs(_components.p,{children:[`Fork checks are disabled by default. To enable them, open `,_jsx(_components.strong,{children:`Settings → GitHub`}),`, choose the repository, and check `,_jsx(_components.strong,{children:`Allow fork pull requests`}),`.`]}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`A contributor opens or updates a PR. The Gauge check links to `,_jsx(_components.strong,{children:`Authorize evaluation`}),`.`]}),`\n`,_jsx(_components.li,{children:`A member of the connected Gauge workspace signs in and reviews the revision, case count, and connections.`}),`\n`,_jsxs(_components.li,{children:[`The member selects `,_jsx(_components.strong,{children:`Authorize evaluation`}),` to run those cases using the workspace’s credits. Gauge waits for any required inputs before starting.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`Opening the page does not launch sessions or spend credits. Each new revision and explicit rerun needs its own approval. GitHub workflow approval is separate; approve the build in GitHub too if required.`}),`\n`,_jsx(_components.p,{children:`GitHub repository access alone does not grant approval rights in Gauge. People outside the Gauge workspace see a message asking them to contact a member. When fork checks are disabled, the Gauge check briefly explains why the evaluation was skipped.`}),`\n`,_jsx(Heading,{level:`2`,id:`read-the-results`,children:`Read the results`}),`\n`,_jsx(_components.p,{children:`Gauge maintains a summary comment for the current PR head. During preparation it shows planned cases and input waits; during execution it shows queued, running, and judging states. Pending judgments are not failures.`}),`\n`,_jsx(_components.p,{children:`The table links each session and shows the case, agent/model, outcome, duration, and token usage. Experience cases include criteria passed; preference cases include the selected product or head-to-head outcome. Preference summaries group selection counts by case, agent, and model. For large suites the comment limits the individual session table.`}),`\n`,_jsx(_components.p,{children:`Once results are settled, each failed criterion gets a separate follow-up comment with the expected behavior, the judge’s explanation, the case, agent/model, commit, and a session link. Execution and judging errors receive their own callouts so you can distinguish a failed product outcome from an incomplete evaluation. Open the linked session to inspect the agent’s work.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Criteria failed:`}),` the session completed, but at least one judged outcome failed.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Execution failed:`}),` the session failed or timed out; inspect its failure reason and trace.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Judging failed:`}),` Gauge could not produce a complete judgment; this is separate from a failed product outcome.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Input preparation failed:`}),` an artifact, preview, or configuration prevented sessions from starting.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`The check completes after sessions and required judging finish. Each new head or explicit rerun updates the summary. Older sessions remain available from their links.`}),`\n`,_jsx(Heading,{level:`2`,id:`troubleshoot-setup`,children:`Troubleshoot setup`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Symptom`}),_jsx(_components.th,{children:`What to check`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`No Gauge check appears`}),_jsxs(_components.td,{children:[`Confirm App repository access, the organization in `,_jsx(_components.code,{children:`gauge.json`}),`, and enabled target branches. After changing settings, trigger a new PR update.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Fork check is awaiting approval`}),_jsxs(_components.td,{children:[`Ask a member of the connected Gauge workspace to follow the `,_jsx(_components.strong,{children:`Authorize evaluation`}),` link.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Fork checks are disabled`}),_jsxs(_components.td,{children:[`Check `,_jsx(_components.strong,{children:`Allow fork pull requests`}),` in the repository’s Gauge settings.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`No evals configured`}),_jsxs(_components.td,{children:[`Add a Markdown case under `,_jsx(_components.code,{children:`gauge-cases/`}),`, or correct the `,_jsx(_components.code,{children:`cases`}),` globs. Commit it before updating the PR.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Waiting for CI`}),_jsx(_components.td,{children:`Confirm the named workflow runs for the candidate commit. Approve it in GitHub if approval is required. Gauge discovers existing runs; it does not trigger them.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Missing package or executable`}),_jsxs(_components.td,{children:[`Check the artifact name and its internal file layout. Match `,_jsx(_components.code,{children:`path`}),`/`,_jsx(_components.code,{children:`paths`}),` to uploaded files. Native files must already be unpacked; npm input must select the packed package.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Waiting for a preview`}),_jsx(_components.td,{children:`Check the candidate SHA, deployment environment and successful status, or the exact comment author/marker/readiness pattern. Make the preview publicly accessible.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`PR check ignores local edits`}),_jsxs(_components.td,{children:[`PR checks read committed files. Commit and push your edits. `,_jsx(_components.code,{children:`gauge run`}),` from the CLI uses your working tree.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Billing or provider configuration blocks sessions`}),_jsxs(_components.td,{children:[`Check the owning organization’s `,_jsx(_components.a,{href:`/agents/guides/billing`,children:`billing`}),` and `,_jsx(_components.a,{href:`/agents/concepts/credentials`,children:`credentials`}),`.`]})]})]})]}),`\n`,_jsx(_components.p,{children:`Discovery waits up to five minutes for a missing build or preview. A known queued or running build/deployment can continue waiting, with abandoned requests expiring after seven days. Waiting for inputs creates no coding sessions or session debit. A failed workflow or absent/expired artifact produces an input error.`}),`\n`,_jsx(Heading,{level:`2`,id:`get-support`,children:`Get support`}),`\n`,_jsxs(_components.p,{children:[`Reach out in Slack or email `,_jsx(_components.a,{href:`mailto:[email protected]`,children:`[email protected]`}),` if you need help getting set up or understanding a result.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"GitHub PR Checks","description":"Test whether coding agents can use your latest product changes before you merge a pull request.","icon":"code-pull-request","href":"/agents/guides/github-pr-checks"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Set up with your coding agent","slug":"set-up-with-your-coding-agent","depth":2,"children":[]},{"title":"Set up your first pull request eval","slug":"set-up-your-first-pull-request-eval","depth":2,"children":[]},{"title":"Measure Agent Preference","slug":"measure-agent-preference","depth":2,"children":[]},{"title":"Configuration schemas and enums","slug":"configuration-schemas-and-enums","depth":2,"children":[]},{"title":"Choose your inputs","slug":"choose-your-inputs","depth":2,"children":[]},{"title":"Previews from PR comments","slug":"previews-from-pr-comments","depth":2,"children":[]},{"title":"Choose when checks run","slug":"choose-when-checks-run","depth":2,"children":[{"title":"Run an eval only for relevant file changes","slug":"run-an-eval-only-for-relevant-file-changes","depth":3,"children":[]}]},{"title":"Fork pull requests","slug":"fork-pull-requests","depth":2,"children":[]},{"title":"Read the results","slug":"read-the-results","depth":2,"children":[]},{"title":"Troubleshoot setup","slug":"troubleshoot-setup","depth":2,"children":[]},{"title":"Get support","slug":"get-support","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"gauge-42561b62","siteName":"Gauge Docs","title":"GitHub PR Checks - Gauge Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T21:49:06.397Z","originalFileLocation":"agents/guides/github-pr-checks.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Test whether coding agents can use your latest product changes before you merge a pull request.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Gauge Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gauge-42561b62/d3-6r91DtnHOn4L9/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/gauge-42561b62/d3-6r91DtnHOn4L9/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gauge-42561b62/d3-6r91DtnHOn4L9/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gauge-42561b62/d3-6r91DtnHOn4L9/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gauge-42561b62/d3-6r91DtnHOn4L9/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gauge-42561b62/d3-6r91DtnHOn4L9/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gauge-42561b62/d3-6r91DtnHOn4L9/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gauge-42561b62/d3-6r91DtnHOn4L9/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gauge-42561b62/d3-6r91DtnHOn4L9/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"GitHub PR Checks - Gauge Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Test whether coding agents can use your latest product changes before you merge a pull request.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Gauge Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.withgauge.com/agents/guides/github-pr-checks\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://gauge-42561b62.mintlify.site/_mintlify/api/og/v2?division=Guides\u0026amp;title=GitHub+PR+Checks\u0026amp;description=Test+whether+coding+agents+can+use+your+latest+product+changes+before+you+merge+a+pull+request.\u0026amp;theme=454bb40999979e0bc12c6790\u0026amp;signature=44f822cef89ed26d52f3e3549f43d5f8bfe0de3959172593cabfbbe6fae3b76b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"GitHub PR Checks - Gauge Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Test whether coding agents can use your latest product changes before you merge a pull request.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gauge-42561b62.mintlify.site/_mintlify/api/og/v2?division=Guides\u0026amp;title=GitHub+PR+Checks\u0026amp;description=Test+whether+coding+agents+can+use+your+latest+product+changes+before+you+merge+a+pull+request.\u0026amp;theme=454bb40999979e0bc12c6790\u0026amp;signature=44f822cef89ed26d52f3e3549f43d5f8bfe0de3959172593cabfbbe6fae3b76b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/gauge-42561b62/d3-6r91DtnHOn4L9/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Gauge Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#051b23\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.withgauge.com/agents/guides/github-pr-checks\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/agents/guides/github-pr-checks.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.withgauge.com/#organization\",\"name\":\"Gauge Docs\",\"url\":\"https://docs.withgauge.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/gauge-42561b62/O5gj27o-wX8DVccM/logo/light.svg?fit=max\u0026auto=format\u0026n=O5gj27o-wX8DVccM\u0026q=85\u0026s=6fb77f0aeb3f1d4b0404a3fb65f04c29\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.withgauge.com#website\",\"name\":\"Gauge Docs\",\"url\":\"https://docs.withgauge.com\",\"publisher\":{\"@id\":\"https://docs.withgauge.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.withgauge.com/agents/guides/github-pr-checks#webpage\",\"url\":\"https://docs.withgauge.com/agents/guides/github-pr-checks\",\"name\":\"GitHub PR Checks\",\"description\":\"Test whether coding agents can use your latest product changes before you merge a pull request.\",\"dateModified\":\"2026-11-19T21:49:06.397Z\",\"isPartOf\":{\"@id\":\"https://docs.withgauge.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.withgauge.com/agents/guides/github-pr-checks#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.withgauge.com/agents/guides/github-pr-checks#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Guides\",\"item\":\"https://docs.withgauge.com/agents/guides/create-an-eval-and-run-an-experiment\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"GitHub PR Checks\",\"item\":\"https://docs.withgauge.com/agents/guides/github-pr-checks\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.withgauge.com/agents/guides/github-pr-checks#article\",\"headline\":\"GitHub PR Checks\",\"name\":\"GitHub PR Checks\",\"description\":\"Test whether coding agents can use your latest product changes before you merge a pull request.\",\"url\":\"https://docs.withgauge.com/agents/guides/github-pr-checks\",\"mainEntityOfPage\":{\"@id\":\"https://docs.withgauge.com/agents/guides/github-pr-checks#webpage\"},\"dateModified\":\"2026-11-19T21:49:06.397Z\",\"publisher\":{\"@id\":\"https://docs.withgauge.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.withgauge.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Gauge Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Gauge Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/agents/guides/github-pr-checks.md","siteName":"Gauge Docs","nav":{"global":null,"products":[{"product":"Gauge Chat","icon":"messages","description":"AI visibility","pages":[{"title":"Gauge Chat","href":"/introduction/welcome"}]},{"product":"Gauge Agents","icon":"code","description":"Coding Agent optimization","groups":[{"group":"Get started","icon":"flag","pages":[{"title":"Gauge Agents overview","sidebarTitle":"Overview","icon":"house","href":"/agents"},{"title":"Quickstart","icon":"rocket","href":"/agents/quickstart"},{"title":"Using Gauge Chat and Gauge Agents","icon":"shuffle","href":"/agents/chat-and-agents"},{"title":"Connect Gauge to your tools","icon":"plug","sidebarTitle":"Connection overview","href":"/introduction/connect-your-tools"}]},{"group":"Concepts","icon":"lightbulb","pages":[{"title":"How Gauge works","icon":"diagram-project","href":"/agents/concepts/how-gauge-works"},{"title":"Agent Preference","icon":"ranking-star","href":"/agents/concepts/agent-preference"},{"title":"Agent Experience","icon":"list-check","href":"/agents/concepts/agent-experience"},{"title":"Inputs","icon":"box-open","href":"/agents/concepts/inputs"},{"title":"Issues","icon":"triangle-exclamation","href":"/agents/concepts/issues"},{"title":"Credentials","icon":"key","href":"/agents/concepts/credentials"}]},{"group":"Guides","icon":"book-open","pages":[{"title":"Create and inspect an eval","icon":"flask","href":"/agents/guides/create-an-eval-and-run-an-experiment"},{"title":"Manage issues","icon":"list-check","href":"/agents/guides/manage-issues"},{"title":"How optimizations work","icon":"arrows-rotate","href":"/agents/guides/how-optimizations-work"},{"title":"AX Check","icon":"magnifying-glass","href":"/agents/guides/ax-check"},{"title":"Agent Traffic","icon":"chart-line","href":"/agents/guides/agent-traffic"},{"title":"Improve agent experience","icon":"wrench","href":"/agents/guides/improve-agent-experience"},{"title":"Test proposed CLI commands","icon":"terminal","href":"/agents/guides/test-cli-rules"},{"title":"Improve agent preference","icon":"arrow-trend-up","href":"/agents/guides/improve-agent-preference"},{"title":"CLI guide","icon":"terminal","href":"/agents/guides/cli"},{"title":"Authenticate with the API","icon":"key","href":"/agents/guides/api-authentication"},{"title":"Use the Agents API","description":"List runs, launch evals, and configure evals and preference prompts with the Gauge Agents API.","icon":"code","href":"/agents/guides/use-the-api"},{"title":"GitHub PR Checks","icon":"code-pull-request","href":"/agents/guides/github-pr-checks"},{"title":"Run evals on private repositories","sidebarTitle":"Private repositories","description":"Give Gauge Agents access to a private GitHub repository and use it as the starting workspace for an eval.","icon":"lock","href":"/agents/guides/private-repositories"},{"title":"Configure runs","icon":"sliders","href":"/agents/guides/configure-a-scenario"},{"title":"Run troubleshooting","icon":"circle-question","href":"/agents/guides/troubleshooting-runs"},{"title":"Billing and credits","icon":"credit-card","href":"/agents/guides/billing"}]},{"group":"API reference","icon":"code","pages":[{"title":"Agents API reference","sidebarTitle":"Overview","icon":"book-open","href":"/agents/api-reference/overview"},{"group":"Endpoints","icon":"list","pages":[{"group":"Batches","pages":[{"title":"Get batch","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/batches/{batchId}","href":"/agents/api-reference/batches/get-batch"},{"title":"List batches","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/batches","href":"/agents/api-reference/batches/list-batches"}]},{"group":"Authentication","pages":[{"title":"Create Cli","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/cli/token","href":"/agents/api-reference/authentication/create-cli"},{"title":"Create Device","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/device/authorize","href":"/agents/api-reference/authentication/create-device"},{"title":"Create Device","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/device/token","href":"/agents/api-reference/authentication/create-device-1"},{"title":"List Me","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/me","href":"/agents/api-reference/authentication/list-me"},{"title":"List API tokens","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/tokens","href":"/agents/api-reference/authentication/list-api-tokens"},{"title":"Create API token","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/tokens","href":"/agents/api-reference/authentication/create-api-token"},{"title":"Delete API token","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/tokens/{tokenId}","href":"/agents/api-reference/authentication/delete-api-token"}]},{"group":"Feedback","pages":[{"title":"Create Feedback","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/feedback","href":"/agents/api-reference/feedback/create-feedback"}]},{"group":"Runs","pages":[{"title":"Get Fork Plans","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/fork-plans/{planId}","href":"/agents/api-reference/runs/get-fork-plans"},{"title":"List related runs","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/runs","href":"/agents/api-reference/runs/list-related-runs"},{"title":"Create run","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/runs/compare","href":"/agents/api-reference/runs/create-run"},{"title":"Get run","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/runs/{runId}","href":"/agents/api-reference/runs/get-run"},{"title":"Cancel run","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/runs/{runId}/cancel","href":"/agents/api-reference/runs/cancel-run"},{"title":"Get run commands","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/runs/{runId}/commands","href":"/agents/api-reference/runs/get-run-commands"},{"title":"Get run diff","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/runs/{runId}/diff","href":"/agents/api-reference/runs/get-run-diff"},{"title":"List runs","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/runs/{runId}/events","href":"/agents/api-reference/runs/list-runs"},{"title":"Fork run","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/runs/{runId}/fork","href":"/agents/api-reference/runs/fork-run"},{"title":"Get run insight","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/runs/{runId}/insight","href":"/agents/api-reference/runs/get-run-insight"},{"title":"List runs","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/runs/{runId}/page","href":"/agents/api-reference/runs/list-runs-1"},{"title":"Regrade run","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/runs/{runId}/regrade","href":"/agents/api-reference/runs/regrade-run"},{"title":"Get run trace","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/runs/{runId}/trace","href":"/agents/api-reference/runs/get-run-trace"},{"title":"Get run web activity","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/runs/{runId}/web","href":"/agents/api-reference/runs/get-run-web-activity"}]},{"group":"Organizations","pages":[{"title":"Create organization","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs","href":"/agents/api-reference/organizations/create-organization"},{"title":"Get organization","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}","href":"/agents/api-reference/organizations/get-organization"},{"title":"List invites","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/invites","href":"/agents/api-reference/organizations/list-invites"},{"title":"List members","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/members","href":"/agents/api-reference/organizations/list-members"},{"title":"Seed onboarding data","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/onboarding/seed","href":"/agents/api-reference/organizations/seed-onboarding-data"},{"title":"List Summary","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/summary","href":"/agents/api-reference/organizations/list-summary"}]},{"group":"AI Traffic","pages":[{"title":"List AI Traffic drains","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/ai-traffic/drains","href":"/agents/api-reference/ai-traffic/list-ai-traffic-drains"},{"title":"Create AI Traffic drain","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/ai-traffic/drains","href":"/agents/api-reference/ai-traffic/create-ai-traffic-drain"},{"title":"Create AI Traffic drain","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/ai-traffic/drains/{drainId}","href":"/agents/api-reference/ai-traffic/create-ai-traffic-drain-1"},{"title":"Delete AI Traffic drain","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/orgs/{org}/ai-traffic/drains/{drainId}","href":"/agents/api-reference/ai-traffic/delete-ai-traffic-drain"}]},{"group":"Billing","pages":[{"title":"List billing","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/billing","href":"/agents/api-reference/billing/list-billing"},{"title":"List usage","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/usage","href":"/agents/api-reference/billing/list-usage"}]},{"group":"Brands","pages":[{"title":"List brands","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/brands","href":"/agents/api-reference/brands/list-brands"},{"title":"Create brand","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/brands","href":"/agents/api-reference/brands/create-brand"},{"title":"Delete brand","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/orgs/{org}/brands/{brandId}","href":"/agents/api-reference/brands/delete-brand"},{"title":"Update brand","deprecated":null,"version":null,"openapi":"/agents/openapi.json patch /api/v1/orgs/{org}/brands/{brandId}","href":"/agents/api-reference/brands/update-brand"}]},{"group":"Checkpoints","pages":[{"title":"List Checkpoints","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/checkpoints","href":"/agents/api-reference/checkpoints/list-checkpoints"},{"title":"Create Checkpoints","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/checkpoints","href":"/agents/api-reference/checkpoints/create-checkpoints"},{"title":"Get Checkpoints","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/checkpoints/{checkpointId}","href":"/agents/api-reference/checkpoints/get-checkpoints"},{"title":"Delete Checkpoints","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/orgs/{org}/checkpoints/{checkpointId}","href":"/agents/api-reference/checkpoints/delete-checkpoints"},{"title":"List Checkpoints","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/checkpoints/{checkpointId}/history","href":"/agents/api-reference/checkpoints/list-checkpoints-1"},{"title":"Create Checkpoints","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/checkpoints/{checkpointId}/restore","href":"/agents/api-reference/checkpoints/create-checkpoints-1"}]},{"group":"Credentials","pages":[{"title":"List credentials","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/connections","href":"/agents/api-reference/credentials/list-credentials"},{"title":"Create credential","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/connections","href":"/agents/api-reference/credentials/create-credential"},{"title":"Delete credential","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/orgs/{org}/connections/{id}","href":"/agents/api-reference/credentials/delete-credential"},{"title":"Set credential","deprecated":null,"version":null,"openapi":"/agents/openapi.json put /api/v1/orgs/{org}/connections/{id}/credential","href":"/agents/api-reference/credentials/set-credential"},{"title":"Create credential","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/connections/{id}/reauthorize","href":"/agents/api-reference/credentials/create-credential-1"}]},{"group":"Dashboards","pages":[{"title":"List dashboards","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/dashboards","href":"/agents/api-reference/dashboards/list-dashboards"},{"title":"Create dashboard","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/dashboards","href":"/agents/api-reference/dashboards/create-dashboard"},{"title":"Get dashboard","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/dashboards/{key}","href":"/agents/api-reference/dashboards/get-dashboard"},{"title":"Delete dashboard","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/orgs/{org}/dashboards/{key}","href":"/agents/api-reference/dashboards/delete-dashboard"},{"title":"Update dashboard","deprecated":null,"version":null,"openapi":"/agents/openapi.json patch /api/v1/orgs/{org}/dashboards/{key}","href":"/agents/api-reference/dashboards/update-dashboard"},{"title":"Set dashboard","deprecated":null,"version":null,"openapi":"/agents/openapi.json put /api/v1/orgs/{org}/dashboards/{key}/filters","href":"/agents/api-reference/dashboards/set-dashboard"}]},{"group":"Agent Experience","pages":[{"title":"List eval sets","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/eval-sets","href":"/agents/api-reference/agent-experience/list-eval-sets"},{"title":"Create eval set","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/eval-sets","href":"/agents/api-reference/agent-experience/create-eval-set"},{"title":"Get eval set","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/eval-sets/{evalSetId}","href":"/agents/api-reference/agent-experience/get-eval-set"},{"title":"Delete eval set","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/orgs/{org}/eval-sets/{evalSetId}","href":"/agents/api-reference/agent-experience/delete-eval-set"},{"title":"Update eval set","deprecated":null,"version":null,"openapi":"/agents/openapi.json patch /api/v1/orgs/{org}/eval-sets/{evalSetId}","href":"/agents/api-reference/agent-experience/update-eval-set"},{"title":"Run eval set","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/eval-sets/{evalSetId}/run","href":"/agents/api-reference/agent-experience/run-eval-set"},{"title":"List related runs","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/eval-sets/{evalSetId}/runs","href":"/agents/api-reference/agent-experience/list-related-runs"},{"title":"Plan eval files","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/run-definitions/plan","href":"/agents/api-reference/agent-experience/plan-eval-files"},{"title":"Create Run Definitions","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/run-definitions/resolve","href":"/agents/api-reference/agent-experience/create-run-definitions"},{"title":"Run eval files","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/run-definitions/run","href":"/agents/api-reference/agent-experience/run-eval-files"},{"title":"Create Run Definitions","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/run-definitions/uploads","href":"/agents/api-reference/agent-experience/create-run-definitions-1"},{"title":"Get run request","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/run-requests/{requestId}","href":"/agents/api-reference/agent-experience/get-run-request"},{"title":"Get run request","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/run-requests/wait","href":"/agents/api-reference/agent-experience/get-run-request-1"}]},{"group":"Execution targets","pages":[{"title":"List execution targets","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/execution-targets","href":"/agents/api-reference/execution-targets/list-execution-targets"}]},{"group":"Issues","pages":[{"title":"List issues","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/issues","href":"/agents/api-reference/issues/list-issues"},{"title":"Get issue","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/issues/{id}","href":"/agents/api-reference/issues/get-issue"},{"title":"Update issue","deprecated":null,"version":null,"openapi":"/agents/openapi.json patch /api/v1/orgs/{org}/issues/{id}","href":"/agents/api-reference/issues/update-issue"},{"title":"List issue recheck runs","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/issues/{id}/recheck","href":"/agents/api-reference/issues/list-issue-recheck-runs"},{"title":"Recheck issue","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/issues/{id}/recheck","href":"/agents/api-reference/issues/recheck-issue"}]},{"group":"Journeys","pages":[{"title":"List Journeys","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/journeys","href":"/agents/api-reference/journeys/list-journeys"},{"title":"Create Journeys","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/journeys","href":"/agents/api-reference/journeys/create-journeys"},{"title":"Get Journeys","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/journeys/{journey}","href":"/agents/api-reference/journeys/get-journeys"},{"title":"Delete Journeys","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/orgs/{org}/journeys/{journey}","href":"/agents/api-reference/journeys/delete-journeys"},{"title":"Update Journeys","deprecated":null,"version":null,"openapi":"/agents/openapi.json patch /api/v1/orgs/{org}/journeys/{journey}","href":"/agents/api-reference/journeys/update-journeys"}]},{"group":"Agent Preference","pages":[{"title":"List markets","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/markets","href":"/agents/api-reference/agent-preference/list-markets"},{"title":"Create market","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/markets","href":"/agents/api-reference/agent-preference/create-market"},{"title":"List Agent Preference prompts","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/visibility-prompts","href":"/agents/api-reference/agent-preference/list-agent-preference-prompts"},{"title":"Create Agent Preference prompt","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/visibility-prompts","href":"/agents/api-reference/agent-preference/create-agent-preference-prompt"},{"title":"Get Agent Preference prompt","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/visibility-prompts/{visibilityPromptId}","href":"/agents/api-reference/agent-preference/get-agent-preference-prompt"},{"title":"Delete Agent Preference prompt","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/orgs/{org}/visibility-prompts/{visibilityPromptId}","href":"/agents/api-reference/agent-preference/delete-agent-preference-prompt"},{"title":"Update Agent Preference prompt","deprecated":null,"version":null,"openapi":"/agents/openapi.json patch /api/v1/orgs/{org}/visibility-prompts/{visibilityPromptId}","href":"/agents/api-reference/agent-preference/update-agent-preference-prompt"},{"title":"Run Agent Preference prompt","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/visibility-prompts/{visibilityPromptId}/run","href":"/agents/api-reference/agent-preference/run-agent-preference-prompt"},{"title":"List related runs","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/visibility-prompts/{visibilityPromptId}/runs","href":"/agents/api-reference/agent-preference/list-related-runs"},{"title":"List preference scenarios","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/visibility-prompts/{visibilityPromptId}/scenarios","href":"/agents/api-reference/agent-preference/list-preference-scenarios"},{"title":"Add preference scenario","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/visibility-prompts/{visibilityPromptId}/scenarios","href":"/agents/api-reference/agent-preference/add-preference-scenario"},{"title":"Get preference scenario","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/visibility-prompts/{visibilityPromptId}/scenarios/{visibilityScenarioId}","href":"/agents/api-reference/agent-preference/get-preference-scenario"},{"title":"Remove preference scenario","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/orgs/{org}/visibility-prompts/{visibilityPromptId}/scenarios/{visibilityScenarioId}","href":"/agents/api-reference/agent-preference/remove-preference-scenario"}]},{"group":"Mcp Authorizations","pages":[{"title":"Create Mcp Authorizations","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/mcp-authorizations","href":"/agents/api-reference/mcp-authorizations/create-mcp-authorizations"},{"title":"Get Mcp Authorizations","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/mcp-authorizations/{authorizationId}","href":"/agents/api-reference/mcp-authorizations/get-mcp-authorizations"}]},{"group":"MCP servers","pages":[{"title":"List MCP servers","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/mcp-servers","href":"/agents/api-reference/mcp-servers/list-mcp-servers"},{"title":"Create MCP server","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/mcp-servers","href":"/agents/api-reference/mcp-servers/create-mcp-server"},{"title":"Get MCP server","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/mcp-servers/{ref}","href":"/agents/api-reference/mcp-servers/get-mcp-server"},{"title":"Delete MCP server","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/orgs/{org}/mcp-servers/{ref}","href":"/agents/api-reference/mcp-servers/delete-mcp-server"},{"title":"Update MCP server","deprecated":null,"version":null,"openapi":"/agents/openapi.json patch /api/v1/orgs/{org}/mcp-servers/{ref}","href":"/agents/api-reference/mcp-servers/update-mcp-server"}]},{"group":"Optimizations","pages":[{"title":"List optimizations","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/optimizations","href":"/agents/api-reference/optimizations/list-optimizations"},{"title":"Create optimization","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/optimizations","href":"/agents/api-reference/optimizations/create-optimization"},{"title":"Get optimization","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/optimizations/{id}","href":"/agents/api-reference/optimizations/get-optimization"},{"title":"Update optimization","deprecated":null,"version":null,"openapi":"/agents/openapi.json patch /api/v1/orgs/{org}/optimizations/{id}","href":"/agents/api-reference/optimizations/update-optimization"},{"title":"Get optimization authoring context","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/optimizations/{id}/authoring","href":"/agents/api-reference/optimizations/get-optimization-authoring-context"},{"title":"List optimizations","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/optimizations/{id}/checkpoints","href":"/agents/api-reference/optimizations/list-optimizations-1"},{"title":"Read optimization file","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/optimizations/{id}/files","href":"/agents/api-reference/optimizations/read-optimization-file"},{"title":"Write optimization file","deprecated":null,"version":null,"openapi":"/agents/openapi.json put /api/v1/orgs/{org}/optimizations/{id}/files","href":"/agents/api-reference/optimizations/write-optimization-file"},{"title":"Add optimization file","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/optimizations/{id}/files","href":"/agents/api-reference/optimizations/add-optimization-file"},{"title":"Remove optimization file","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/orgs/{org}/optimizations/{id}/files","href":"/agents/api-reference/optimizations/remove-optimization-file"},{"title":"Edit optimization page","deprecated":null,"version":null,"openapi":"/agents/openapi.json patch /api/v1/orgs/{org}/optimizations/{id}/files","href":"/agents/api-reference/optimizations/edit-optimization-page"},{"title":"Finish optimization","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/optimizations/{id}/finish","href":"/agents/api-reference/optimizations/finish-optimization"},{"title":"Launch optimization","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/optimizations/{id}/launch","href":"/agents/api-reference/optimizations/launch-optimization"},{"title":"Get optimization launch","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/optimizations/{id}/launches/{launchId}","href":"/agents/api-reference/optimizations/get-optimization-launch"},{"title":"Create optimization","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/optimizations/{id}/sessions","href":"/agents/api-reference/optimizations/create-optimization-1"}]},{"group":"Personas","pages":[{"title":"List personas","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/personas","href":"/agents/api-reference/personas/list-personas"},{"title":"Create persona","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/personas","href":"/agents/api-reference/personas/create-persona"},{"title":"Get persona","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/personas/{personaId}","href":"/agents/api-reference/personas/get-persona"},{"title":"Delete persona","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/orgs/{org}/personas/{personaId}","href":"/agents/api-reference/personas/delete-persona"},{"title":"Update persona","deprecated":null,"version":null,"openapi":"/agents/openapi.json patch /api/v1/orgs/{org}/personas/{personaId}","href":"/agents/api-reference/personas/update-persona"}]},{"group":"Preference Schedule","pages":[{"title":"Update Preference Schedule","deprecated":null,"version":null,"openapi":"/agents/openapi.json patch /api/v1/orgs/{org}/preference-schedule","href":"/agents/api-reference/preference-schedule/update-preference-schedule"}]},{"group":"Provider keys","pages":[{"title":"List provider keys","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/provider-keys","href":"/agents/api-reference/provider-keys/list-provider-keys"},{"title":"Delete provider key","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/orgs/{org}/provider-keys","href":"/agents/api-reference/provider-keys/delete-provider-key"},{"title":"Set provider key","deprecated":null,"version":null,"openapi":"/agents/openapi.json put /api/v1/orgs/{org}/provider-keys/{type}","href":"/agents/api-reference/provider-keys/set-provider-key"},{"title":"Delete provider key","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/orgs/{org}/provider-keys/{type}","href":"/agents/api-reference/provider-keys/delete-provider-key-1"}]},{"group":"Analytics","pages":[{"title":"Create report","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/query","href":"/agents/api-reference/analytics/create-report"},{"title":"Get query metadata","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/query/metadata","href":"/agents/api-reference/analytics/get-query-metadata"},{"title":"List statistics","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/stats/brands","href":"/agents/api-reference/analytics/list-statistics"},{"title":"List statistics","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/stats/domains","href":"/agents/api-reference/analytics/list-statistics-1"},{"title":"List statistics","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/stats/funnel","href":"/agents/api-reference/analytics/list-statistics-2"},{"title":"List statistics","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/stats/installs","href":"/agents/api-reference/analytics/list-statistics-3"},{"title":"List statistics","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/stats/rankings","href":"/agents/api-reference/analytics/list-statistics-4"}]},{"group":"Repositories","pages":[{"title":"List repositories","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/repos","href":"/agents/api-reference/repositories/list-repositories"},{"title":"Create repository","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/repos","href":"/agents/api-reference/repositories/create-repository"},{"title":"Delete repository","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/orgs/{org}/repos","href":"/agents/api-reference/repositories/delete-repository"},{"title":"Update repository","deprecated":null,"version":null,"openapi":"/agents/openapi.json patch /api/v1/orgs/{org}/repos","href":"/agents/api-reference/repositories/update-repository"},{"title":"Resync repository","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/repos/resync","href":"/agents/api-reference/repositories/resync-repository"}]},{"group":"Skill Imports","pages":[{"title":"Create Skill Imports","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/skill-imports","href":"/agents/api-reference/skill-imports/create-skill-imports"}]},{"group":"Skills","pages":[{"title":"List skills","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/skills","href":"/agents/api-reference/skills/list-skills"},{"title":"Create skill","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/skills","href":"/agents/api-reference/skills/create-skill"},{"title":"Get skill","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/skills/{ref}","href":"/agents/api-reference/skills/get-skill"},{"title":"Delete skill","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/orgs/{org}/skills/{ref}","href":"/agents/api-reference/skills/delete-skill"},{"title":"Update skill","deprecated":null,"version":null,"openapi":"/agents/openapi.json patch /api/v1/orgs/{org}/skills/{ref}","href":"/agents/api-reference/skills/update-skill"},{"title":"Reingest skill","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/skills/{ref}/reingest","href":"/agents/api-reference/skills/reingest-skill"},{"title":"List related runs","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/skills/{ref}/runs","href":"/agents/api-reference/skills/list-related-runs"},{"title":"Create skill","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/skills/{ref}/versions","href":"/agents/api-reference/skills/create-skill-1"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/agents/openapi.json get /api/v1/orgs/{org}/tags","href":"/agents/api-reference/tags/list-tags"},{"title":"Create tag","deprecated":null,"version":null,"openapi":"/agents/openapi.json post /api/v1/orgs/{org}/tags","href":"/agents/api-reference/tags/create-tag"},{"title":"Delete tag","deprecated":null,"version":null,"openapi":"/agents/openapi.json delete /api/v1/orgs/{org}/tags/{tagId}","href":"/agents/api-reference/tags/delete-tag"},{"title":"Update tag","deprecated":null,"version":null,"openapi":"/agents/openapi.json patch /api/v1/orgs/{org}/tags/{tagId}","href":"/agents/api-reference/tags/update-tag"}]}]}]},{"group":"Resources","icon":"book","pages":[{"title":"Changelog","icon":"clock-rotate-left","href":"/resources/changelog"}]}]}]},"basePath":"","title":"GitHub PR Checks - Gauge Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-D0FT0qQs.js","DynamicMarkdown-CQM9Bhbv.js","zoom-image-lightbox-BQ4tbj_9.js","lightbox-handle-r17bVUz3.js"]}