docs: drop the -y flag from the npx install command - #196
Merged
Conversation
Every user-facing surface advertised `npx -y shellshare`. The flag only suppresses npm's one-time "Ok to proceed?" confirm, and it made the shortest way to try shellshare read like a command with options to understand. `npx shellshare` is what people type and what the README already showed, so the site, llms.txt, AGENTS.md and the npm package README now agree with it. The home page assertion in the e2e suite moves with the template - it matched the literal string, so leaving it would have failed. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
1 participant
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.
Every user-facing surface advertised
npx -y shellshare. The flag only suppresses npm's one-time "Ok to proceed?" confirm, and it made the shortest way to try shellshare read like a command with options to understand.npx shellshareis what people type — and what the top-level README already showed — so the site,llms.txt,AGENTS.mdand the npm package README now agree with it.Changed:
templates/index.html— the copy-to-clipboard install line, the typed demo, the FAQ named-room example, and the JSON-LD FAQ answertemplates/llms.txtandAGENTS.md— the agent-facing install lines (comment column kept aligned)npm/shellshare/README.md— both scripting examplese2e/test_api.py— the home-page assertion matched the literal string, so it moves with the templateVerification
make lintcleane2e/test_api.py -k TestInstallOptionspasses against a release build-yvariants anywhere (including.github/,Makefile,src/, package scripts), no other assertion on the old string, and no CSS/JS that depends on the literal command width — the demo's typing animation derives its per-character delay from the actual text length, so the 5s budget is unchanged.One trade-off, flagged
Without
-y, a first run on a machine with a cold npx cache hits npm'sOk to proceed? (y)confirm. That matters most for the piped recipe innpm/shellshare/README.md(tail -f build.log | npx shellshare --json), where the prompt and the piped payload share stdin. Deliberate — the flag is being dropped on purpose — but worth knowing before merging.🤖 Generated with Claude Code