docs: add CLI / tenant-config eval authoring guide - #195
Merged
Conversation
Adds docs/CLI_CONFIG_EVALS.md — a concise how-to for authoring CLI / tenant-config evals that grade the agent's command trace against a live, provisioned tenant rather than files on disk. Covers how they differ from standard evals, goal-only PROMPT.md with provision: auth0-tenant, event graders + a trace-aware judge, and points at the mfa_tenant_cli reference eval. Cross-linked from ADDING_EVALS.md.
📝 WalkthroughWalkthroughThe changes add a dedicated guide for CLI and tenant-configuration evaluations. The existing evaluation guide now directs authors to it and limits its scope to standard file-based evaluations. ChangesCLI evaluation documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/CLI_CONFIG_EVALS.md`:
- Around line 93-95: Update the verification command in CLI_CONFIG_EVALS.md to
include the required npm run format check alongside npm run lint and npm test,
preserving the existing build step and command sequence.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: c379eb57-7be6-4549-af6c-85af8928df5a
📒 Files selected for processing (2)
docs/ADDING_EVALS.mddocs/CLI_CONFIG_EVALS.md
arpit-jn
approved these changes
Aug 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
✏️ Changes
Adds
docs/CLI_CONFIG_EVALS.md, a concise how-to for authoring CLI / tenant-config evals: evals that grade the agent's command trace against a live, provisioned throwaway tenant rather than files on disk.ADDING_EVALS.mdalready mentionsprovisionand the event graders in passing, but no single page walks through authoring one of these evals end to end. This guide fills that gap so the pattern is repeatable.The guide covers how CLI evals differ from standard file-based evals (artifact, scaffold, graders, judge, environment), a goal-only
PROMPT.mdwithprovision: auth0-tenantand what that field does, and agraders.tsusing the event primitives (ranCommand/ranCommandOneOf/ranCommandsInOrder) plus a trace-aware holistic judge. It points at themfa_tenant_clireference eval, and adds a cross-link fromADDING_EVALS.md.Docs-only; no code changes.
🔮 Type of Change
🔗 References
Reference eval:
apps/auth0-evals/src/evals/mfa/tenant-cli/(mfa_tenant_cli)I added at least one link (task, Slack thread, etc.) to explain why this change is needed.
📖 Documentation
This PR is the documentation change: it adds
docs/CLI_CONFIG_EVALS.mdand cross-links it fromdocs/ADDING_EVALS.md.🎯 Testing
No automated tests apply; this is a docs-only change. Rendering verified locally.
]