Skip to content

docs: add macOS and Linux install examples #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Thanhdn1984 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add macOS and Linux install examples #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 102 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,20 @@ git clone https://github.com/<your-username>/claude-code-fact-verification-hook.

This repo assumes you will reference the hook scripts by absolute path from your Claude Code settings.

Choose a stable location that will not move between Claude Code sessions. Common choices are:

| Platform | Example repo path | Typical Claude Code settings path |
| --- | --- | --- |
| macOS | `/Users/alice/tools/claude-code-fact-verification-hook` | `/Users/alice/.claude/settings.json` |
| Linux | `/home/alice/tools/claude-code-fact-verification-hook` | `/home/alice/.claude/settings.json` |
| Windows | `C:\Users\Alice\tools\claude-code-fact-verification-hook` | `C:\Users\Alice\.claude\settings.json` |

You can confirm your home directory with:

```bash
echo "$HOME"
```

### 3. Optional: create a config file

Copy:
Expand All @@ -180,6 +194,94 @@ if you want custom thresholds or MCP regex patterns.

Use `settings.example.json` as a starting point and replace `<REPO_PATH>` with your real absolute path.

For macOS, if you cloned the repo into `/Users/alice/tools/claude-code-fact-verification-hook`, copy this into `/Users/alice/.claude/settings.json`:

```json
{
"hooks": {
"UserPromptSubmit": [
{
"hooks": [
{
"type": "command",
"command": "python3 \"/Users/alice/tools/claude-code-fact-verification-hook/hooks/fact_prompt_gate.py\"",
"timeout": 5
}
]
}
],
"PostToolUse": [
{
"matcher": "Read|WebFetch|WebSearch|Bash|mcp__.*",
"hooks": [
{
"type": "command",
"command": "python3 \"/Users/alice/tools/claude-code-fact-verification-hook/hooks/track_verification.py\"",
"timeout": 5
}
]
}
],
"Stop": [
{
"hooks": [
{
"type": "command",
"command": "python3 \"/Users/alice/tools/claude-code-fact-verification-hook/hooks/verification_stop_gate.py\"",
"timeout": 10
}
]
}
]
}
}
```

For Linux, if you cloned the repo into `/home/alice/tools/claude-code-fact-verification-hook`, copy this into `/home/alice/.claude/settings.json`:

```json
{
"hooks": {
"UserPromptSubmit": [
{
"hooks": [
{
"type": "command",
"command": "python3 \"/home/alice/tools/claude-code-fact-verification-hook/hooks/fact_prompt_gate.py\"",
"timeout": 5
}
]
}
],
"PostToolUse": [
{
"matcher": "Read|WebFetch|WebSearch|Bash|mcp__.*",
"hooks": [
{
"type": "command",
"command": "python3 \"/home/alice/tools/claude-code-fact-verification-hook/hooks/track_verification.py\"",
"timeout": 5
}
]
}
],
"Stop": [
{
"hooks": [
{
"type": "command",
"command": "python3 \"/home/alice/tools/claude-code-fact-verification-hook/hooks/verification_stop_gate.py\"",
"timeout": 10
}
]
}
]
}
}
```

If your `settings.json` already has hooks, merge the matching `UserPromptSubmit`, `PostToolUse`, and `Stop` entries instead of replacing the whole file.

### 5. Restart Claude Code

Hook registration changes are safest after a restart or a fresh session.
Expand Down