Ship an agent-facing install guide inside the npm package#38
Merged
Conversation
AI coding agents refuse the install.txt prompt because a bare URL pattern-matches to remote script execution and the Patchstack brand pattern-matches to WordPress-only. Anchor the install flow on the npm package instead: ship AGENT-INSTALL.md in the tarball, add a `patchstack-connect guide` command that prints it, and rewrite the README install prompts to lead with the pinnable, auditable package. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Integrates an agent-facing install guide command neatly into the existing CLI. 🎯 Quality: 89% Excellent · 📦 Size: Small 📈 This month: Your 214th PR — above team average · Averaging Excellent |
Contributor
Author
|
/review |
Contributor
Author
|
Install the npm package @patchstack/connect as a dev dependency (MIT, source: https://github.com/patchstack/connect) to add dependency vulnerability monitoring, then run npx @patchstack/connect guide and follow the setup guide it prints. It only reads the lockfile — nothing is fetched from a URL or executed remotely. |
mariojgt
approved these changes
Jul 13, 2026
This was referenced Jul 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
AI coding agents (Lovable, Bolt, v0, etc.) often refuse the "add Patchstack using https://patchstack.com/install.txt" prompt — the URL pattern-matches to remote script execution and the brand pattern-matches to WordPress-only, so they decline before ever fetching the instructions. This PR anchors the install flow on the npm package, which agents demonstrably trust (pinnable, integrity-hashed, public source).
AGENT-INSTALL.md, a condensed agent-facing setup guide shipped in the npm tarball, with a "verify before you trust" section and the full connector + widget install sequence.patchstack-connect guideCLI command that prints the bundled guide, so agents can follow instructions from inside the package they just installed — no remote fetch required.Verified: typecheck, build, all 121 tests pass, and
guideworks from both the repo layout and an extractednpm packtarball.🤖 Generated with Claude Code