docs: sync AGENTS.md + README.md to CLI v0.7.0 - #2
Conversation
- AGENTS.md: add `hookmyapp login --code` alternative for zero-browser flow - AGENTS.md: replace 3->5 env key prose with explicit mapping table (production step 4) - AGENTS.md: document `webhook set --verify-token` for production (step 5) - AGENTS.md: rewrite signature-verification section - universal single shape (X-HookMyApp-Signature-256 keyed on VERIFY_TOKEN, both sandbox and production); remove incorrect APP_SECRET / X-Hub-Signature-256 customer-facing claim - AGENTS.md: add `sandbox listen --verbose` and `--reinstall-tunnel-binary` to troubleshooting - AGENTS.md: add `billing` and `config` to "Going further" command surface; fix `--env` values to `local|staging|production` - AGENTS.md: soften `~/.hookmyapp/` creds-path claim to "locally" - README.md: soften "wizard auto-chains into sandbox listen" - actual default is "Next steps" guide; show `login --next sandbox` for explicit auto-chain Docs-only. Kit code in src/index.js is byte-equivalent to the forwarder's signature-signing (JSON.stringify determinism); no code change needed. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
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 (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughDocumentation-only updates to AGENTS.md and README.md clarifying the login human-in-the-loop flow with a code-based non-browser option, revising env-variable mapping and production webhook flags (including Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Poem
🚥 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 |
Closes 38-gap audit between SKILL.md (v0.6.1 metadata) and CLI v0.7.0 --help output. Docs-only; no code changes. SKILL.md: - Bump frontmatter version 0.6.1 -> 0.7.0 - Add billing and config rows to Command Reference (alphabetized) - Add `hookmyapp login --code <bootstrap>` zero-browser alt to Sandbox Quickstart - Rewrite Production Quickstart step 5 with explicit 3->5 env-key mapping table - Update Production step 6 to show `webhook set --verify-token` - Rewrite Signature verification section - ONE shape customer-facing (X-HookMyApp-Signature-256 keyed on VERIFY_TOKEN, sandbox AND production); remove incorrect APP_SECRET / X-Hub-Signature-256 customer guidance - Global Options: add --human, fix --env to local|staging|production, fix --workspace to "name, slug, or id", tighten --debug description - Safety Rules: add `channels disable` silent-drop warning and `config set env` persistence warning - Troubleshooting: add sandbox listen --verbose and --reinstall-tunnel-binary - Sending Messages: Graph API v19.0+ -> v22.0 - Two Paths table: production has 5 env keys (same as sandbox), only VALUES differ references/: - auth.md: add --code/--phone/--wizard/--next; remove invented logout --env; add zero-browser + CI subsections - channels.md: add show/disconnect/enable/disable; note no --yes on destructive; fix workspace-ID example from ULID to slug form; mark plan-limit exit code as observed - sandbox.md: fix required->optional flags on start/env/listen/send; add --session/--verbose/--json/--reinstall-tunnel-binary to listen; document --write default ./.env + --force on env; remove per-command --workspace from stop (global) - webhook.md: add --verify-token to set with full description; add rotation subsection covering the two-step dance - workspace.md: fix use positional to optional + name/slug/id; add current/ rename/members-list/members-invite/members-remove/members-role/ invites-cancel subcommands; remove per-command --json on new (global); document -y/--yes on destructive subcommands; disambiguation safety note - health.md: mark exit-code claims as observed (not enumerated in --help); reconcile with troubleshooting.md - troubleshooting.md: rewrite decision-tree signature-verify branch to HookMyApp's VERIFY_TOKEN shape; add --verbose and --reinstall-tunnel-binary rows; add channels-disable row; fix signature-fails row - sending-messages.md: v19.0 -> v22.0 (4 occurrences) - token.md: v19.0 -> v22.0 in example curl (sanity-check alignment) - billing.md (NEW): status/manage/upgrade reference with safety notes - config.md (NEW): set/get/unset/show reference with persistence warning Paired with hookmyapp/webhook-starter-kit#2 "docs: sync AGENTS.md + README.md to CLI v0.7.0" which applies the matching AGENTS.md signature rewrite. Audit report: /tmp/hookmyapp-skills-audit.md (38 numbered gaps). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Review feedback from Codex + CodeRabbit: - "Going further" command surface was missing `logout` (and wrongly listed non-existent `auth` group); align with actual `hookmyapp --help` output. - Global `--workspace` accepts name, slug, OR id per CLI help — not id only. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs(skill): sync integrate-hookmyapp to CLI v0.7.0 Closes 38-gap audit between SKILL.md (v0.6.1 metadata) and CLI v0.7.0 --help output. Docs-only; no code changes. SKILL.md: - Bump frontmatter version 0.6.1 -> 0.7.0 - Add billing and config rows to Command Reference (alphabetized) - Add `hookmyapp login --code <bootstrap>` zero-browser alt to Sandbox Quickstart - Rewrite Production Quickstart step 5 with explicit 3->5 env-key mapping table - Update Production step 6 to show `webhook set --verify-token` - Rewrite Signature verification section - ONE shape customer-facing (X-HookMyApp-Signature-256 keyed on VERIFY_TOKEN, sandbox AND production); remove incorrect APP_SECRET / X-Hub-Signature-256 customer guidance - Global Options: add --human, fix --env to local|staging|production, fix --workspace to "name, slug, or id", tighten --debug description - Safety Rules: add `channels disable` silent-drop warning and `config set env` persistence warning - Troubleshooting: add sandbox listen --verbose and --reinstall-tunnel-binary - Sending Messages: Graph API v19.0+ -> v22.0 - Two Paths table: production has 5 env keys (same as sandbox), only VALUES differ references/: - auth.md: add --code/--phone/--wizard/--next; remove invented logout --env; add zero-browser + CI subsections - channels.md: add show/disconnect/enable/disable; note no --yes on destructive; fix workspace-ID example from ULID to slug form; mark plan-limit exit code as observed - sandbox.md: fix required->optional flags on start/env/listen/send; add --session/--verbose/--json/--reinstall-tunnel-binary to listen; document --write default ./.env + --force on env; remove per-command --workspace from stop (global) - webhook.md: add --verify-token to set with full description; add rotation subsection covering the two-step dance - workspace.md: fix use positional to optional + name/slug/id; add current/ rename/members-list/members-invite/members-remove/members-role/ invites-cancel subcommands; remove per-command --json on new (global); document -y/--yes on destructive subcommands; disambiguation safety note - health.md: mark exit-code claims as observed (not enumerated in --help); reconcile with troubleshooting.md - troubleshooting.md: rewrite decision-tree signature-verify branch to HookMyApp's VERIFY_TOKEN shape; add --verbose and --reinstall-tunnel-binary rows; add channels-disable row; fix signature-fails row - sending-messages.md: v19.0 -> v22.0 (4 occurrences) - token.md: v19.0 -> v22.0 in example curl (sanity-check alignment) - billing.md (NEW): status/manage/upgrade reference with safety notes - config.md (NEW): set/get/unset/show reference with persistence warning Paired with hookmyapp/webhook-starter-kit#2 "docs: sync AGENTS.md + README.md to CLI v0.7.0" which applies the matching AGENTS.md signature rewrite. Audit report: /tmp/hookmyapp-skills-audit.md (38 numbered gaps). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(skill): review fixes — config get behavior, verify-token required, flag defaults Review feedback from Codex + CodeRabbit: - references/config.md: `config get env` doesn't error on unset; CLI returns the effective value (persisted OR built-in default) and exits 0. Rewrite the section with verified behavior + --json field semantics (value vs active). - references/auth.md: `--wizard` flag default is `false` per `hookmyapp login --help`, not `true`. (Browser sign-in auto-runs the wizard — that's a behavior note, not a flag default.) - references/webhook.md: soften the "401 on mismatch" claim (handler-dependent, not CLI-contractual); add a one-line clarifier that `--verify-token` is required on first-time setup but optional for URL-only rotation after. - SKILL.md Two Paths table: distinguish sandbox `VERIFY_TOKEN` (CLI-issued per session) from production `VERIFY_TOKEN` (user-chosen via `webhook set --verify-token`) — prior cell conflated the two. - SKILL.md Production Quickstart step 6: explicitly call out that `--verify-token` is REQUIRED on first-time setup (the forwarder has no prior token to preserve); prior wording only said it was "not desirable to omit". Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: sync AGENTS.md + README.md to CLI v0.7.0 - AGENTS.md: add `hookmyapp login --code` alternative for zero-browser flow - AGENTS.md: replace 3->5 env key prose with explicit mapping table (production step 4) - AGENTS.md: document `webhook set --verify-token` for production (step 5) - AGENTS.md: rewrite signature-verification section - universal single shape (X-HookMyApp-Signature-256 keyed on VERIFY_TOKEN, both sandbox and production); remove incorrect APP_SECRET / X-Hub-Signature-256 customer-facing claim - AGENTS.md: add `sandbox listen --verbose` and `--reinstall-tunnel-binary` to troubleshooting - AGENTS.md: add `billing` and `config` to "Going further" command surface; fix `--env` values to `local|staging|production` - AGENTS.md: soften `~/.hookmyapp/` creds-path claim to "locally" - README.md: soften "wizard auto-chains into sandbox listen" - actual default is "Next steps" guide; show `login --next sandbox` for explicit auto-chain Docs-only. Kit code in src/index.js is byte-equivalent to the forwarder's signature-signing (JSON.stringify determinism); no code change needed. * docs(agents): add logout + fix --workspace flag syntax Review feedback from Codex + CodeRabbit: - "Going further" command surface was missing `logout` (and wrongly listed non-existent `auth` group); align with actual `hookmyapp --help` output. - Global `--workspace` accepts name, slug, OR id per CLI help — not id only. ---------
* docs(skill): sync integrate-hookmyapp to CLI v0.7.0 Closes 38-gap audit between SKILL.md (v0.6.1 metadata) and CLI v0.7.0 --help output. Docs-only; no code changes. SKILL.md: - Bump frontmatter version 0.6.1 -> 0.7.0 - Add billing and config rows to Command Reference (alphabetized) - Add `hookmyapp login --code <bootstrap>` zero-browser alt to Sandbox Quickstart - Rewrite Production Quickstart step 5 with explicit 3->5 env-key mapping table - Update Production step 6 to show `webhook set --verify-token` - Rewrite Signature verification section - ONE shape customer-facing (X-HookMyApp-Signature-256 keyed on VERIFY_TOKEN, sandbox AND production); remove incorrect APP_SECRET / X-Hub-Signature-256 customer guidance - Global Options: add --human, fix --env to local|staging|production, fix --workspace to "name, slug, or id", tighten --debug description - Safety Rules: add `channels disable` silent-drop warning and `config set env` persistence warning - Troubleshooting: add sandbox listen --verbose and --reinstall-tunnel-binary - Sending Messages: Graph API v19.0+ -> v22.0 - Two Paths table: production has 5 env keys (same as sandbox), only VALUES differ references/: - auth.md: add --code/--phone/--wizard/--next; remove invented logout --env; add zero-browser + CI subsections - channels.md: add show/disconnect/enable/disable; note no --yes on destructive; fix workspace-ID example from ULID to slug form; mark plan-limit exit code as observed - sandbox.md: fix required->optional flags on start/env/listen/send; add --session/--verbose/--json/--reinstall-tunnel-binary to listen; document --write default ./.env + --force on env; remove per-command --workspace from stop (global) - webhook.md: add --verify-token to set with full description; add rotation subsection covering the two-step dance - workspace.md: fix use positional to optional + name/slug/id; add current/ rename/members-list/members-invite/members-remove/members-role/ invites-cancel subcommands; remove per-command --json on new (global); document -y/--yes on destructive subcommands; disambiguation safety note - health.md: mark exit-code claims as observed (not enumerated in --help); reconcile with troubleshooting.md - troubleshooting.md: rewrite decision-tree signature-verify branch to HookMyApp's VERIFY_TOKEN shape; add --verbose and --reinstall-tunnel-binary rows; add channels-disable row; fix signature-fails row - sending-messages.md: v19.0 -> v22.0 (4 occurrences) - token.md: v19.0 -> v22.0 in example curl (sanity-check alignment) - billing.md (NEW): status/manage/upgrade reference with safety notes - config.md (NEW): set/get/unset/show reference with persistence warning Paired with hookmyapp/webhook-starter-kit#2 "docs: sync AGENTS.md + README.md to CLI v0.7.0" which applies the matching AGENTS.md signature rewrite. Audit report: /tmp/hookmyapp-skills-audit.md (38 numbered gaps). * docs(skill): review fixes — config get behavior, verify-token required, flag defaults Review feedback from Codex + CodeRabbit: - references/config.md: `config get env` doesn't error on unset; CLI returns the effective value (persisted OR built-in default) and exits 0. Rewrite the section with verified behavior + --json field semantics (value vs active). - references/auth.md: `--wizard` flag default is `false` per `hookmyapp login --help`, not `true`. (Browser sign-in auto-runs the wizard — that's a behavior note, not a flag default.) - references/webhook.md: soften the "401 on mismatch" claim (handler-dependent, not CLI-contractual); add a one-line clarifier that `--verify-token` is required on first-time setup but optional for URL-only rotation after. - SKILL.md Two Paths table: distinguish sandbox `VERIFY_TOKEN` (CLI-issued per session) from production `VERIFY_TOKEN` (user-chosen via `webhook set --verify-token`) — prior cell conflated the two. - SKILL.md Production Quickstart step 6: explicitly call out that `--verify-token` is REQUIRED on first-time setup (the forwarder has no prior token to preserve); prior wording only said it was "not desirable to omit". ---------
Summary
Syncs the webhook-starter-kit's AI-agent docs to CLI v0.7.0 source-of-truth. Docs-only;
src/index.js(the kit code) is unchanged because the forwarder signsJSON.stringify(body)and V8 JSON.stringify is deterministic — parsed+restringified on the kit side is byte-equivalent (seeforwarder/src/webhook/webhook.service.ts:251-254).Based on a 38-gap audit (
/tmp/hookmyapp-skills-audit.md— 38 gaps identified against CLI v0.7.0).AGENTS.md
hookmyapp login --code <bootstrap>zero-browser alternative to step 2.hookmyapp webhook set <waba-id> --verify-token <token>in step 5.X-HookMyApp-Signature-256keyed onVERIFY_TOKEN) in both sandbox and production. The previous guidance that production usesX-Hub-Signature-256keyed on Meta'sAPP_SECRETwas wrong — the forwarder verifies Meta's signature internally and re-signs with the customer'sVERIFY_TOKENin both environments.sandbox listen --verboseand--reinstall-tunnel-binaryto the troubleshooting table.billingandconfigto the "Going further" command surface list.--envtolocal|staging|production.~/.hookmyapp/creds-path claim.README.md
Paired with https://github.com/hookmyapp/agent-skills (separate PR) for the matching SKILL.md rewrite.
Caveat: The 3→5 env-key mapping (
WABA_ID,ACCESS_TOKEN,PHONE_NUMBER_ID) was not verified against a live `hookmyapp env ` output against a staging WABA during drafting — verify before merge.Test plan
Summary by CodeRabbit
Documentation