docs: surface Claude Code plugin#286
Conversation
📝 WalkthroughWalkthroughThis PR updates the README and documentation to describe integrating foxguard via a Claude Code plugin ( ChangesClaude Code Plugin Integration Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related issues
Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Review rate limit: 9/10 reviews remaining, refill in 6 minutes. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/claude-code-integration.md`:
- Around line 40-42: Update the example and surrounding text to show that the
hook severity is controlled by the FOXGUARD_HOOK_SEVERITY environment variable
(defaulting to "medium") rather than a fixed flag; replace the hard-coded
command example `foxguard --format json --severity medium <edited-file>` with
one that indicates the env override (e.g.
`FOXGUARD_HOOK_SEVERITY=${FOXGUARD_HOOK_SEVERITY:-medium} foxguard --format json
<edited-file>`) and add a short note stating "uses FOXGUARD_HOOK_SEVERITY
(default: medium)". Ensure you reference the env var name FOXGUARD_HOOK_SEVERITY
in the explanatory sentence so readers understand runtime behavior.
🪄 Autofix (Beta)
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: 6788e094-682a-49c5-9ef7-4f1f4a809282
📒 Files selected for processing (2)
README.mddocs/claude-code-integration.md
| ```sh | ||
| foxguard --format json --severity medium <edited-file> | ||
| ``` |
There was a problem hiding this comment.
Document the effective hook command with env override.
Line 40–Line 42 currently implies a fixed medium threshold, but the hook actually uses FOXGUARD_HOOK_SEVERITY (defaulting to medium). Please reflect that so operators don’t misread runtime behavior.
Suggested doc tweak
-foxguard --format json --severity medium <edited-file>
+foxguard --format json --severity "${FOXGUARD_HOOK_SEVERITY:-medium}" <edited-file>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ```sh | |
| foxguard --format json --severity medium <edited-file> | |
| ``` |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/claude-code-integration.md` around lines 40 - 42, Update the example and
surrounding text to show that the hook severity is controlled by the
FOXGUARD_HOOK_SEVERITY environment variable (defaulting to "medium") rather than
a fixed flag; replace the hard-coded command example `foxguard --format json
--severity medium <edited-file>` with one that indicates the env override (e.g.
`FOXGUARD_HOOK_SEVERITY=${FOXGUARD_HOOK_SEVERITY:-medium} foxguard --format json
<edited-file>`) and add a short note stating "uses FOXGUARD_HOOK_SEVERITY
(default: medium)". Ensure you reference the env var name FOXGUARD_HOOK_SEVERITY
in the explanatory sentence so readers understand runtime behavior.
Summary
Verification
git diff --checkRefs #285
Summary by CodeRabbit