Add AGENTS.md + cross-tool redirects for AI coding agents - #1
Conversation
Adds AGENTS.md as the self-contained guide any AI coding agent reads when a user clones this kit and asks their agent to wire up WhatsApp. Adds CLAUDE.md, GEMINI.md, .cursorrules, and .github/copilot-instructions.md as 1-line redirects so each tool's auto-loaded file points at AGENTS.md. README.md gains a "For AI Agents" section so human readers see the affordance. The agent now knows to drive @gethookmyapp/cli (sandbox env, listen, send, channels connect, webhook set) without needing to fetch any external repo.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (6)
📝 WalkthroughWalkthroughThis pull request adds comprehensive AI-agent guidance documentation to the repository. It introduces Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Adds AGENTS.md as the self-contained guide any AI coding agent reads when a user clones this kit and asks their agent to wire up WhatsApp. Adds CLAUDE.md, GEMINI.md, .cursorrules, and .github/copilot-instructions.md as 1-line redirects so each tool's auto-loaded file points at AGENTS.md. README.md gains a "For AI Agents" section so human readers see the affordance. The agent now knows to drive @gethookmyapp/cli (sandbox env, listen, send, channels connect, webhook set) without needing to fetch any external repo.
Summary
AGENTS.mdat repo root — the self-contained guide any AI coding agent (Claude Code, Cursor, Codex, Gemini CLI, GitHub Copilot) reads when a user clones this kit and asks their agent to wire up WhatsApp via@gethookmyapp/cli. Covers sandbox quickstart, production setup, signature verification, HUMAN ACTION REQUIRED steps, and safety rules.CLAUDE.md,GEMINI.md,.cursorrules,.github/copilot-instructions.md.README.mdso human readers see the affordance exists.Why
Today the README is human-oriented. When a user opens this kit in their AI agent and says "wire this up to WhatsApp," the agent has no auto-loaded context telling it the CLI exists, what commands to run, or which steps need human browser interaction. This change installs the AGENTS.md cross-tool standard plus tool-specific redirects so every major AI coding tool finds the same guidance with zero configuration.
Test plan
hookmyapp sandbox env --write .env+npm start+hookmyapp sandbox listenwithout inventing commands.src/index.jsshape, HUMAN ACTION REQUIRED blocks present forlogin+channels connect, safety rules cover credential redaction + production webhook URL confirmation.Summary by CodeRabbit