docs(readme): clarify install-time protection covers npm, pnpm, and yarn#1432
Open
John-David Dalton (jdalton) wants to merge 1 commit into
Open
docs(readme): clarify install-time protection covers npm, pnpm, and yarn#1432John-David Dalton (jdalton) wants to merge 1 commit into
John-David Dalton (jdalton) wants to merge 1 commit into
Conversation
Collaborator
Author
|
CI note (both red checks are pre-existing, not from this PR):
This PR is docs-only (README.md), so it cannot affect any test or lint logic — it hits the exact same two failures, which is direct proof they are pre-existing infra issues. |
John-David Dalton (jdalton)
force-pushed
the
docs/999-readme-firewall-managers
branch
3 times, most recently
from
July 25, 2026 16:17
e934e79 to
710c2b5
Compare
The safe-npm FAQ historically said install-time protection was npm-only, while older READMEs mentioned pnpm/yarn wrapping — a documented inconsistency (#999). The CLI now routes `socket npm`, `socket pnpm`, and `socket yarn` through Socket Firewall, so all three block malicious packages before install. Spell this out in the README Usage section so the supported package managers are unambiguous. Refs #999
John-David Dalton (jdalton)
force-pushed
the
docs/999-readme-firewall-managers
branch
from
July 25, 2026 17:42
710c2b5 to
8206ed3
Compare
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.
What
Resolves the documentation inconsistency reported in #999: the safe-npm FAQ says install-time protection is npm-only, while older READMEs mentioned wrapping pnpm and yarn. A reader can't tell which is current.
This updates the README Usage section to state plainly that
socket npm,socket pnpm, andsocket yarnall run the underlying package manager through Socket Firewall.Refs #999.
Why this is accurate
Verified against the current command definitions — all three forward to Socket Firewall (
sfw):src/commands/npm/cmd-npm.mts— "Run npm with Socket Firewall security"src/commands/pnpm/cmd-pnpm.mts— "Run pnpm with Socket Firewall security"src/commands/yarn/cmd-yarn.mts— "Run yarn with Socket Firewall security"So install-time protection is no longer npm-only; the FAQ's "npm only" statement is the stale one.
Change
README.md— expand the "Audit an install before it runs" example to cover npm/pnpm/yarn and add a one-paragraph note about Socket Firewall.Scope / follow-up
SocketDev/docsrepo and still needs a matching update — flagged for a docs-repo follow-up.socket pnpm/socket yarnare functional but hidden from top-level--help(npm is the primary documented entry point); documenting them here is intentional so their existence is discoverable.Testing
Docs-only.
markdownlint-cli2reports no errors inREADME.md(the 5 findings in the run are pre-existing, in unrelateddocs/agents.md/fleet/*.mdfiles).Note
Low Risk
Documentation-only change to README.md with no runtime or security behavior impact.
Overview
Updates the Usage section so install-time auditing is described for npm, pnpm, and yarn, not only npm.
The "Audit an install before it runs" example now includes
socket pnpm installandsocket yarn add, and a short note explains thatsocket npm,socket pnpm, andsocket yarnall delegate to Socket Firewall so malicious packages can be blocked before install—explicitly stating that protection is no longer npm-only.Reviewed by Cursor Bugbot for commit f15c7c6. Configure here.