cc-safety-net 0.6.2 → 0.7.1

package/README.md

@@ -6,6 +6,7 @@
 [![Claude Code](https://img.shields.io/badge/Claude%20Code-D27656)](#claude-code-installation)
 [![OpenCode](https://img.shields.io/badge/OpenCode-black)](#opencode-installation)
 [![Gemini CLI](https://img.shields.io/badge/Gemini%20CLI-678AE3)](#gemini-cli-installation)
+[![Copilot CLI](https://img.shields.io/badge/Copilot%20CLI-4EA5C9)](#github-copilot-cli-installation)
 [![License: MIT](https://img.shields.io/badge/License-MIT-red.svg)](https://opensource.org/licenses/MIT)
 
 <div align="center">
@@ -26,11 +27,13 @@ A Claude Code plugin that acts as a safety net, catching destructive git and fil
   - [Claude Code Installation](#claude-code-installation)
   - [OpenCode Installation](#opencode-installation)
   - [Gemini CLI Installation](#gemini-cli-installation)
+  - [GitHub Copilot CLI Installation](#github-copilot-cli-installation)
 - [Status Line Integration](#status-line-integration)
   - [Setup via Slash Command](#setup-via-slash-command)
   - [Manual Setup](#manual-setup)
   - [Emoji Mode Indicators](#emoji-mode-indicators)
 - [Diagnostics](#diagnostics)
+- [Explain (Debug Analysis)](#explain-debug-analysis)
 - [Commands Blocked](#commands-blocked)
 - [Commands Allowed](#commands-allowed)
 - [What Happens When Blocked](#what-happens-when-blocked)
@@ -210,6 +213,38 @@ gemini extensions install https://github.com/kenryu42/gemini-safety-net
 > }
 > ```
 
+---
+
+### GitHub Copilot CLI Installation
+
+Safety Net supports GitHub Copilot CLI via its [hooks system](https://docs.github.com/en/copilot/concepts/agents/coding-agent/about-hooks).
+
+1. **Create the hooks directory** in your repository:
+
+   ```bash
+   mkdir -p .github/hooks
+   ```
+
+2. **Create `.github/hooks/safety-net.json`**:
+
+   ```json
+   {
+     "version": 1,
+     "hooks": {
+       "preToolUse": [
+         {
+           "type": "command",
+           "bash": "npx -y cc-safety-net --copilot-cli",
+           "cwd": ".",
+           "timeoutSec": 15
+         }
+       ]
+     }
+   }
+   ```
+
+The hook will intercept bash commands and block destructive operations before they execute.
+
 ## Status Line Integration
 
 Safety Net can display its status in Claude Code's status line, showing whether protection is active and which modes are enabled.
@@ -243,7 +278,22 @@ Add the following to your `~/.claude/settings.json`:
 }
 ```
 
-**Using npm:**
+**Using Claude X:**
+
+```json
+{
+  "statusLine": {
+    "type": "command",
+    "command": "BUN_BE_BUN=1 claude x cc-safety-net --statusline"
+  }
+}
+```
+> [!NOTE]
+> The `claude x` command is only compatible with the native version of Claude Code. If you installed via npm, please use `npx` or `bunx` instead.
+
+
+
+**Using NPM:**
 
 ```json
 {
@@ -314,6 +364,31 @@ The doctor command checks:
 | `--json` | Output in JSON format (useful for sharing in bug reports) |
 | `--skip-update-check` | Skip the npm version check |
 
+## Explain (Debug Analysis)
+
+Trace how Safety Net analyzes a command step-by-step. Useful for debugging why a command is blocked or allowed, or when developing custom rules.
+
+```bash
+npx cc-safety-net explain "git reset --hard"
+# or with bun
+bunx cc-safety-net explain "git reset --hard"
+```
+
+### Options
+
+| Flag | Description |
+|------|-------------|
+| `--json` | Output analysis as JSON |
+| `--cwd <path>` | Use custom working directory for analysis |
+
+### Examples
+
+```bash
+npx cc-safety-net explain "rm -rf /"
+npx cc-safety-net explain --json "git checkout -- file.txt"
+npx cc-safety-net explain --cwd /tmp "git status"
+```
+
 ## Commands Blocked
 
 | Command Pattern | Why It's Dangerous |
@@ -391,6 +466,11 @@ Beyond the built-in protections, you can define your own blocking rules to enfor
 
 > [!TIP]
 > Use `/set-custom-rules` to create custom rules interactively with natural language.
+>
+> **GitHub Copilot CLI users**: Since Copilot CLI doesn't support custom slash commands, prompt your agent with:
+> ```text
+> run npx cc-safety-net --custom-rules-doc and help me set up custom rules
+> ```
 
 ### Quick Example