Add opt-in CodeRabbit onboarding skill suite - #36
Conversation
Route create, update, and validation requests through the official CLI so every host shares one guided implementation. Document the new config skill across supported distribution surfaces without duplicating YAML logic.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📜 Recent review details🔇 Additional comments (1)
📝 WalkthroughWalkthroughThe PR adds ChangesSolutions onboarding suite
Estimated code review effort: 3 (Moderate) | ~20 minutes Mergeability Score: ⚪ Minimal · up to The PR adds an opt-in, unbundled onboarding skill suite with explicit approval and verification boundaries; no actionable merge-blocking risk remains beyond normal checks and review. Suggested reviewers: Poem
Important Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional. ❌ Failed checks (1 inconclusive)
✅ Passed checks (5 passed)
✨ Finishing Touches✨ Simplify code
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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 `@README.md`:
- Around line 157-159: Remove the configuration skill’s claims about guided
create and update flows from README.md lines 157-159, retaining only supported
CLI validation behavior. Keep the configuration skill excluded from the Live
entry in DISTRIBUTION_CHANNELS.md line 11; no change is required there if it is
already absent.
In `@skills/config/SKILL.md`:
- Around line 20-47: Update skills/config/SKILL.md lines 20-47 and README.md
lines 207-223 to align configuration routing with the documented CLI: use
`coderabbit config validate [file]` for validation, and remove the undocumented
`config --validate`, interactive create/update flow, and configuration
`--generate` claims. Preserve guidance to report CLI diagnostics and avoid
direct YAML edits or fallback workflows.
- Line 3: Remove the portable “/config” trigger from the description in
skills/config/SKILL.md. Update README.md lines 25-28 to document only supported
host-specific invocation forms, including the namespaced Claude Code command and
Antigravity form; state that Gemini CLI activates the skill automatically
through activate_skill.
🪄 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: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 0bffc7ce-a704-4000-9087-b8204f6412ed
📒 Files selected for processing (9)
.claude-plugin/plugin.json.cursor-plugin/plugin.jsonCHANGELOG.mdDISTRIBUTION_CHANNELS.mdREADME.mdgemini-extension.jsonplugin.jsonskills/config/SKILL.mdskills/config/agents/openai.yaml
📜 Review details
🧰 Additional context used
📓 Path-based instructions (4)
{gemini-extension.json,plugin.json}
⚙️ CodeRabbit configuration file
{gemini-extension.json,plugin.json}: Verify manifest paths, metadata, and packaged components against the repository tree.
Files:
plugin.jsongemini-extension.json
skills/**/SKILL.md
⚙️ CodeRabbit configuration file
skills/**/SKILL.md: Keep skill Markdown focused on domain context, routing, and workflow framing.
Put repeatable deterministic operations in referenced scripts or tools when practical.
Use focused references for details that are only needed in some workflows.
Flag ambiguous or conflicting guidance.
Keep guidance portable across declared agents unless it is explicitly scoped.
Verify CLI commands and options against current public documentation.
Check the Agent Skills specification, the AGENTS.md open format, and the
current public documentation for every declared host agent.
Files:
skills/config/SKILL.md
{.claude-plugin,.cursor-plugin}/**/*.json
⚙️ CodeRabbit configuration file
{.claude-plugin,.cursor-plugin}/**/*.json: Verify manifest paths, versions, metadata, and packaged components against the repository tree.
Files:
.cursor-plugin/plugin.json.claude-plugin/plugin.json
{README.md,CHANGELOG.md,DISTRIBUTION_CHANNELS.md}
⚙️ CodeRabbit configuration file
{README.md,CHANGELOG.md,DISTRIBUTION_CHANNELS.md}: Keep public installation commands, release status, and source-of-truth claims accurate and mutually consistent.
Files:
CHANGELOG.mdREADME.mdDISTRIBUTION_CHANNELS.md
🪛 LanguageTool
skills/config/SKILL.md
[style] ~26-~26: It’s more common nowadays to write this noun as one word.
Context: ...t config --validate ``` When the user names a file, pass that exact path as one arg...
(RECOMMENDED_COMPOUNDS)
[style] ~53-~53: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ..., YAML mutation logic, or validation. - Never invoke PR comment commands as a substit...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 SkillSpector (2.5.1)
skills/config/SKILL.md
[warning] 46: [EA2] Autonomous Decision Making: Skill enables autonomous high-impact decisions without human-in-the-loop verification. Critical operations (destructive commands, financial transactions, data deletion) should require explicit user confirmation.
Remediation: Add human-in-the-loop confirmation for destructive, irreversible, or high-impact operations. Never auto-execute commands that modify files, send data, or alter system state.
(Excessive Agency (EA2))
🔇 Additional comments (6)
skills/config/SKILL.md (2)
13-18: 🩺 Stability & AvailabilityAlign prerequisites with the existing CLI contract.
These checks prove only that the binary runs and that help output exists. They do not prove authentication or the minimum supported CLI version. The current CLI exposes
auth statusanddoctorchecks for these concerns. (docs.coderabbit.ai)Reuse the prerequisite gate from
skills/code-review/SKILL.md, or document and test why configuration operations do not require it.#!/usr/bin/env bash set -euo pipefail rg -n -C 8 'auth|version|minimum|doctor' \ skills/code-review/SKILL.md skills/config/SKILL.md
6-8: LGTM!Also applies to: 10-12, 40-41, 49-54
skills/config/agents/openai.yaml (1)
1-4: LGTM!.claude-plugin/plugin.json (1)
4-4: 🗄️ Data Integrity & IntegrationVerify the packaging contract for the new skill across all manifests.
The changed descriptions do not prove that
skills/config/SKILL.mdis packaged or that existing installations receive the updated component set.
.claude-plugin/plugin.json#L4-L4: verify root-levelskills/packaging and explicit-version cache invalidation..cursor-plugin/plugin.json#L5-L5: verify root-level skill packaging and update behavior.gemini-extension.json#L4-L4: verify extension skill inclusion and version/update behavior.plugin.json#L3-L3: verify Antigravity skill inclusion and update behavior.#!/usr/bin/env bash set -euo pipefail python - <<'PY' import json from pathlib import Path manifests = [ Path(".claude-plugin/plugin.json"), Path(".cursor-plugin/plugin.json"), Path("gemini-extension.json"), Path("plugin.json"), ] assert Path("skills/config/SKILL.md").is_file() for manifest in manifests: data = json.loads(manifest.read_text()) print(manifest, "name=", data.get("name"), "version=", data.get("version")) print("description=", data.get("description")) PY for manifest in \ .claude-plugin/plugin.json \ .cursor-plugin/plugin.json \ gemini-extension.json \ plugin.json do printf '\n%s\n' "$manifest" rg -n '"(version|skills|components|include|path)"' "$manifest" || true doneExpected: every manifest either packages the repository-root
skills/directory or explicitly listsskills/config, and any explicit version/update cache is refreshed for this component addition.As per path instructions: Verify manifest paths, versions, metadata, and packaged components against the repository tree.
README.md (1)
8-10: LGTM!Also applies to: 146-147
CHANGELOG.md (1)
9-11: LGTM!
nehal-a2z
changed the title
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 `@DISTRIBUTION_CHANNELS.md`:
- Around line 11-12: Exclude skills/config/ from the live Skills package by
adding the repository’s supported Skills CLI exclusion configuration, or
explicitly scope the live package listing to omit it. Ensure discovery of
SKILL.md files cannot include the in-development configuration skill while
preserving all other live skills.
In `@skills/config/SKILL.md`:
- Around line 22-36: Align the configuration documentation with the released CLI
by removing or redesigning the unsupported Detailed workflow and all references
to undocumented commands, flags, and JSON fields. Update skills/config/SKILL.md
at lines 22-36, 49-57, 64-83, and 92-98, plus
skills/config/references/detailed-discovery.md lines 65-78; retain only the
documented `cr config validate [file]` workflow unless acceptance tests
establish the newer contract.
🪄 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: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 13f076c2-2ba3-438d-8785-d1087280f2b0
📒 Files selected for processing (6)
CHANGELOG.mdDISTRIBUTION_CHANNELS.mdREADME.mdskills/config/SKILL.mdskills/config/agents/openai.yamlskills/config/references/detailed-discovery.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (2)
{README.md,CHANGELOG.md,DISTRIBUTION_CHANNELS.md}
⚙️ CodeRabbit configuration file
{README.md,CHANGELOG.md,DISTRIBUTION_CHANNELS.md}: Keep public installation commands, release status, and source-of-truth claims accurate and mutually consistent.
Files:
CHANGELOG.mdDISTRIBUTION_CHANNELS.mdREADME.md
skills/**/SKILL.md
⚙️ CodeRabbit configuration file
skills/**/SKILL.md: Keep skill Markdown focused on domain context, routing, and workflow framing.
Put repeatable deterministic operations in referenced scripts or tools when practical.
Use focused references for details that are only needed in some workflows.
Flag ambiguous or conflicting guidance.
Keep guidance portable across declared agents unless it is explicitly scoped.
Verify CLI commands and options against current public documentation.
Check the Agent Skills specification, the AGENTS.md open format, and the
current public documentation for every declared host agent.
Files:
skills/config/SKILL.md
🪛 LanguageTool
README.md
[style] ~157-~157: Consider using a different verb for a more formal wording.
Context: ...dings grouped by severity 4. Optionally fix issues and re-review Configuration req...
(FIX_RESOLVE)
🔇 Additional comments (7)
README.md (3)
8-10: Keep the draft configuration workflow out of active README instructions.These lines present guided configuration as available. Lines 209-214 correctly mark
configas release-gated, andDISTRIBUTION_CHANNELS.mdLines 11-12 mark it as not user-facing. The README therefore gives conflicting release guidance. The current official CLI reference documentscr config validatebut does not documentconfig --generate. (docs.coderabbit.ai)Remove the active Quickstart and Usage triggers, or label all configuration instructions as unreleased until the required CLI commands are available.
As per path instructions, keep public installation guidance and release status mutually consistent.
Also applies to: 25-29, 159-160
Source: Path instructions
152-158: LGTM!
209-229: LGTM!CHANGELOG.md (1)
9-11: LGTM!skills/config/SKILL.md (1)
3-15: LGTM!Also applies to: 17-20, 38-45, 59-63, 100-113
skills/config/agents/openai.yaml (1)
1-4: LGTM!skills/config/references/detailed-discovery.md (1)
1-63: LGTM!
| coderabbit --version | ||
| coderabbit config --help | ||
| ``` | ||
|
|
||
| If `coderabbit` is missing or `config` does not support the requested operation, ask the user to upgrade from <https://docs.coderabbit.ai/cli>. Do not implement a fallback editor. | ||
|
|
||
| Local configuration does not require CodeRabbit authentication. Do not block this workflow on `coderabbit auth status`. | ||
|
|
||
| For an explicit validation-only request, run: | ||
|
|
||
| ```bash | ||
| coderabbit config validate | ||
| ``` | ||
|
|
||
| Pass a user-named file as one argument. Add `--json` when structured diagnostics help the host agent. |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | 🏗️ Heavy lift
🧩 Analysis chain
🏁 Script executed:
#!/usr/bin/env bash
set -euo pipefail
config_help="$(coderabbit config --help 2>&1)"
for token in --generate --validate inspect apply; do
grep -F -- "$token" <<<"$config_help"
done
detailed_help="$(coderabbit config --detailed --help 2>&1)"
validate_help="$(coderabbit config validate --help 2>&1)"
inspect_help="$(coderabbit config inspect --help 2>&1)"
apply_help="$(coderabbit config apply --help 2>&1)"
grep -F -- '--json' <<<"$validate_help"
grep -F -- '--json' <<<"$inspect_help"
for token in --dry-run --base --yes --json; do
grep -F -- "$token" <<<"$apply_help"
doneRepository: coderabbitai/skills
Length of output: 161
🏁 Script executed:
#!/usr/bin/env bash
set -euo pipefail
printf '%s\n' '--- relevant files ---'
git ls-files 'skills/config/SKILL.md' 'skills/config/references/detailed-discovery.md' 'AGENTS.md' 'skills/**/SKILL.md' | sed -n '1,120p'
printf '%s\n' '--- config skill ---'
cat -n skills/config/SKILL.md
printf '%s\n' '--- detailed discovery reference ---'
cat -n skills/config/references/detailed-discovery.md
printf '%s\n' '--- declared host agents and repository guidance ---'
find . -name AGENTS.md -o -name '*AGENT*' | sort | sed -n '1,120p'
rg -n -i 'host agent|agent|coderabbit config|--generate|config inspect|config apply|config validate' --glob 'AGENTS.md' --glob 'skills/**/SKILL.md' --glob 'skills/**/references/**' . | sed -n '1,240p'Repository: coderabbitai/skills
Length of output: 16070
🌐 Web query:
Current official CodeRabbit CLI reference for coderabbit config, including subcommands, flags, JSON output, and configuration inspection or apply support
💡 Result:
The official CodeRabbit CLI provides a specific command for configuration validation, but it does not include subcommands for directly modifying or applying general application settings via the CLI. Configuration is primarily managed via a.coderabbit.yaml file in the root of your repository [1][2][3]. CLI Configuration Command The primary CLI command related to configuration is: cr config validate [file] This command is used to validate the syntax and settings of your CodeRabbit YAML configuration against the current official schema [1][4]. Usage Details: - Without a file argument, the CLI automatically detects the Git repository root and validates the.coderabbit.yaml or.coderabbit.yml file [1][4]. - If a specific file path is provided, it validates that file instead [1][4]. - The validation process involves checking the YAML syntax and then fetching and verifying against the current official schema [1][4]. Errors returned will identify the affected line, configuration path, and expected value [1][4]. Application Support and Inspection - JSON Output: While specific JSON-formatted output flags for the config command are not explicitly detailed in the reference, the CLI does support an --agent flag for other commands (like cr review) to produce structured output [1][5]. - Configuration Inspection: To inspect the resolved configuration currently in use for a repository, you should use the @coderabbitai configuration command within a Pull Request environment [3][6]. This displays the full, resolved configuration, including source comments that indicate where settings originated (e.g., repository YAML, central configuration, or global overrides) [3][6]. For full repository configuration details, developers are directed to the official online Configuration Reference, which is automatically generated from the CodeRabbit schema and contains all available settings, types, and examples [2][7].
Citations:
- 1: https://docs.coderabbit.ai/cli/reference
- 2: https://docs.coderabbit.ai/reference/configuration
- 3: https://docs.coderabbit.ai/getting-started/yaml-configuration.md
- 4: https://coderabbit.mintlify.app/cli/reference
- 5: https://docs.coderabbit.ai/cli/headless-cli-integration
- 6: https://docs.coderabbit.ai/reference/review-commands
- 7: https://coderabbit.mintlify.app/reference/configuration
🌐 Web query:
Agent Skills specification current official documentation SKILL.md format and AGENTS.md open format current public documentation
💡 Result:
The SKILL.md and AGENTS.md files serve distinct roles in AI agent configuration. SKILL.md is a structured specification for discrete, reusable agent capabilities [1][2], while AGENTS.md is a lightweight, open-standard "README" for providing project-wide context and guidance to coding agents [3][4]. SKILL.md Specification SKILL.md is the core file for defining an "Agent Skill," which packages instructions, resources, and optional scripts into a single directory [1][2]. Official documentation, maintained by the Agent Skills ecosystem (e.g., agentskills.io, openagentskills.dev), defines the following format [1][5]: Structure: It must contain YAML frontmatter followed by Markdown content [1][6]. Required Fields (YAML Frontmatter): name: A unique identifier (max 64 characters; lowercase letters, numbers, and hyphens only; must match the parent directory name) [1][7]. description: A description of what the skill does and when to use it (max 1024 characters; non-empty) [1][8]. Optional Fields: license: License reference [1][7]. compatibility: Environment requirements (max 500 characters) [1][8]. metadata: Arbitrary key-value mapping [1][6]. allowed-tools: Space-separated list of pre-approved tools (experimental) [1][8]. The Markdown body contains the procedural knowledge (steps, examples, and best practices) required for the agent to execute the task [1][9]. AGENTS.md Open Format AGENTS.md is a simple, schema-less Markdown file used to guide coding agents within a repository [3][4]. It is designed as an open, community-driven standard (maintained at agents.md) rather than a rigid configuration file [3][4]. Purpose: Provides project-specific context (e.g., build/test commands, code style, security considerations) that coding agents read into their system context [3][4]. Format: There is no required schema or validation [4]. It relies on standard Markdown, allowing users to define their own sections [3]. Discovery: Coding agents typically walk the directory tree from the current directory to the project root, reading the nearest AGENTS.md file [3][10]. Interoperability: It is supported by various coding agents (including Cursor, Copilot, Aider, and Claude Code) [3][4]. It is recommended as a single source of truth, where tool-specific files (like.cursorrules or CLAUDE.md) should reference the AGENTS.md file rather than duplicate its content [4].
Citations:
- 1: https://agentskills.io/specification
- 2: https://github.com/agentskills/agentskills
- 3: https://agents.md/
- 4: https://docs.atlan.com/agents/concepts/agents-md
- 5: https://openagentskills.dev/docs/specification
- 6: https://github.com/agentskills/agentskills/blob/main/docs/specification.mdx
- 7: https://learn.microsoft.com/en-us/agent-framework/agents/skills
- 8: https://openagentskills.dev/docs/writing-skill-md
- 9: https://platform.claude.com/docs/en/agents-and-tools/agent-skills/overview
- 10: https://learn.chatgpt.com/docs/agent-configuration/agents-md
🏁 Script executed:
#!/usr/bin/env bash
set -euo pipefail
printf '%s\n' '--- repository-wide config command references ---'
rg -n --hidden -S \
'coderabbit config|cr config|config --generate|config --validate|config inspect|config apply|config --detailed' \
. \
-g '!node_modules' -g '!dist' -g '!build' | sed -n '1,260p'
printf '%s\n' '--- official CLI reference excerpts ---'
for url in \
'https://docs.coderabbit.ai/cli/reference' \
'https://coderabbit.mintlify.app/cli/reference' \
'https://docs.coderabbit.ai/reference/configuration'
do
printf '\nURL: %s\n' "$url"
curl -LfsS --max-time 20 "$url" |
tr '\r\n' ' ' |
grep -oE '.{0,180}(config validate|config inspect|config apply|--generate|--validate|--detailed|--json).{0,260}' |
sed -n '1,40p' || true
doneRepository: coderabbitai/skills
Length of output: 5541
🌐 Web query:
site:docs.coderabbit.ai/cli/reference "config validate" "config inspect" "config apply"
💡 Result:
The specific combination of commands config validate, config inspect, and config apply as a standard triplet does not correspond to a single, universally defined CLI pattern across software. However, the command config validate is used by the CodeRabbit CLI (cr config validate) to verify that a YAML configuration file conforms to the official schema [1]. While validate, inspect, and apply are common verbs in configuration management workflows, tools typically implement these as part of their own command hierarchies rather than a standardized set. If you are working with a specific tool, it is recommended to check that tool's documentation for the exact command structure, as these terms are frequently used individually to describe: 1. Validate: Checking a configuration file for syntax errors or schema compliance [1]. 2. Inspect: Viewing or outputting the current state or parsed representation of a configuration. 3. Apply: Implementing or pushing the configuration to a live environment or system.
Citations:
Align the configuration workflow with the released CLI.
The current CLI reference documents cr config validate [file] only. It does not document config --detailed, config inspect, config apply, --dry-run, --base, --yes, or the required JSON fields. Remove or redesign the unsupported Detailed workflow, or add acceptance tests when the CLI contract is released.
📍 Affects 2 files
skills/config/SKILL.md#L22-L36(this comment)skills/config/SKILL.md#L49-L57skills/config/SKILL.md#L64-L83skills/config/SKILL.md#L92-L98skills/config/references/detailed-discovery.md#L65-L78
🤖 Prompt for 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.
In `@skills/config/SKILL.md` around lines 22 - 36, Align the configuration
documentation with the released CLI by removing or redesigning the unsupported
Detailed workflow and all references to undocumented commands, flags, and JSON
fields. Update skills/config/SKILL.md at lines 22-36, 49-57, 64-83, and 92-98,
plus skills/config/references/detailed-discovery.md lines 65-78; retain only the
documented `cr config validate [file]` workflow unless acceptance tests
establish the newer contract.
Source: Path instructions
nehal-a2z
changed the title
1 participant
Summary
Adds a solutions-assisted CodeRabbit onboarding suite:
/onboard— evidence-backed readiness, exact admin handoffs, and optional first-review proof./config— Standard CLI setup or a patient Detailed proposal through CLI inspect, validation, dry-run, base-hash checking, and apply./connect— permission-aware Jira/Linear, MCP, linked-repository, and reporting setup without handling credentials or pretending YAML proves connection health.All three skills are thin skins over the CodeRabbit CLI and backend. They do not create pull requests, edit YAML directly, copy schema/default logic, mutate dashboard state without approval, or invent remote state the product cannot verify.
Assisted distribution boundary
These are intentionally not part of the default skill package:
solutions/, outside the conventionalskills/package root used bynpx skills, native plugins, andcoderabbit skillsrelease extraction./solutions/ export-ignoreexcludes them from tagged release archives.skills/bundle remains exactlyautofixandcode-review.An intentional assisted engagement can install one from its exact tree URL and exact skill name; the commands live only in the maintainer-facing distribution inventory.
Safety contract
Unknownand becomes an explicit human handoff./configlets the central-aware guided CLI create a first sparse file before Detailed mode proposes broader changes./connectdistinguishes live connection state from repository usage settings./onboardnever creates a synthetic change, branch, commit, or pull request to prove setup.References
Validation
quick_validate.py solutions/onboard— PASS.quick_validate.py solutions/config— PASS.quick_validate.py solutions/connect— PASS.jq empty .claude-plugin/plugin.json .cursor-plugin/plugin.json gemini-extension.json plugin.json— PASS.coderabbit config validate .coderabbit.yaml— PASS against the current official schema.git diff --check— PASS.npx --yes skills add . --list— PASS; lists onlyautofixandcode-review./configinstall — PASS;SKILL.md, OpenAI metadata, and Detailed reference copied.skills/autofixandskills/code-review, with nosolutions/entries./onboardand/connectproduced honest handoffs under no-write/no-auth constraints, and/configrefused to bypass an older CLI missing the required protocol.Release state
Keep this PR draft until the required guided configuration CLI is in an official release. The suite remains unbundled even after merge and is shared only by exact path for intentional assisted use.
Summary by CodeRabbit
New Features
/onboard,/config, and/connectskills for setup readiness, configuration management, and context integrations.Release Improvements