diff --git a/README.md b/README.md index 9b823d5..4d8a20d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +> [!NOTE] +> This project was developed entirely with AI coding assistance (Claude Opus 4.6 via Cursor IDE) and has not undergone manual review. It is provided as-is and may require adjustments for other environments. + # cursor-flasher A macOS daemon that flashes a pulsing border and plays a sound when your [Cursor](https://cursor.com) AI agent needs attention. @@ -6,8 +9,8 @@ A macOS daemon that flashes a pulsing border and plays a sound when your [Cursor Uses [Cursor hooks](https://cursor.com/docs/agent/hooks) for reliable detection: -- **`preToolUse`** — fires when the agent wants to run a shell command, write a file, or use any tool that may need approval. **Pulses** the border continuously and plays a sound until you click the Cursor window. -- **`stop`** — fires when the agent loop ends. **Flashes** the border once, briefly. +- `**preToolUse**` — fires when the agent wants to run a shell command, write a file, or use any tool that may need approval. **Pulses** the border continuously and plays a sound until you click the Cursor window. +- `**stop`** — fires when the agent loop ends. **Flashes** the border once, briefly. Only tools in the `approval_tools` list trigger the pulse (default: `Shell`, `Write`, `Delete`). Auto-approved tools like `Read` and `Grep` are ignored. @@ -112,12 +115,16 @@ uv run cursor-flasher stop ## Troubleshooting **Flashing on every tool call (too noisy):** + - Edit `~/.cursor-flasher/config.yaml` and narrow down `approval_tools` to just `Shell`. **No flash at all:** + - Check daemon: `uv run cursor-flasher status` - Check hooks installed: `ls ~/.cursor/hooks/cursor-flasher-notify.py` - Check Cursor Settings → Hooks tab for execution logs **Pulse doesn't stop:** + - Click the Cursor window to bring it to focus — the pulse auto-dismisses when Cursor is the frontmost app. +