Skip to content

docs: add macOS and Linux install notes #9

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
Adamchaua wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add macOS and Linux install notes #9

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
40 changes: 40 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,46 @@ 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.

#### macOS

Claude Code settings commonly live under your home directory. Create the directory if it does not exist, then copy the example settings:

```bash
mkdir -p ~/.claude
if [ ! -f ~/.claude/settings.json ]; then
cp settings.example.json ~/.claude/settings.json
fi
python3 - <<'PY'
from pathlib import Path
settings = Path.home() / ".claude" / "settings.json"
repo = Path.cwd().resolve()
settings.write_text(settings.read_text().replace("<REPO_PATH>", str(repo)))
print(f"Updated {settings}")
PY
```

If you already have `~/.claude/settings.json`, merge the `hooks` section manually instead of overwriting it.

#### Linux

The Linux setup is the same for most distributions:

```bash
mkdir -p ~/.claude
if [ ! -f ~/.claude/settings.json ]; then
cp settings.example.json ~/.claude/settings.json
fi
python3 - <<'PY'
from pathlib import Path
settings = Path.home() / ".claude" / "settings.json"
repo = Path.cwd().resolve()
settings.write_text(settings.read_text().replace("<REPO_PATH>", str(repo)))
print(f"Updated {settings}")
PY
```

If your Claude Code configuration is stored somewhere else, copy the generated `hooks` entries into that settings file and keep the hook script paths absolute.

### 5. Restart Claude Code

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