docs: prefer local npm install#6854
Open
iamujjwalsinha wants to merge 1 commit intoanomalyco:devfrom
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the top-level onboarding docs to prefer a local SST install for Node-based projects, aligning the README and docs landing page with the linked issue’s goal of emphasizing npm install sst over a global install.
Changes:
- Reword the CLI installation guidance to recommend installing SST locally in Node projects.
- Add an example showing the CLI being run after local installation with
npx sst dev. - Keep the global installer instructions as the fallback path in both the docs index and README.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
www/src/content/docs/docs/index.mdx |
Updates the main docs landing page’s CLI section to prefer local installation and adds a local-run example. |
README.md |
Mirrors the new installation guidance in the repository’s primary onboarding instructions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| npm install sst | ||
| ``` | ||
|
|
||
| You can then run the CLI with your package manager. |
| npx sst dev | ||
| ``` | ||
|
|
||
| If you are not using Node, you can install the CLI globally. |
Comment on lines
+279
to
+281
| ```bash | ||
| npx sst dev | ||
| ``` |
| npx sst dev | ||
| ``` | ||
|
|
||
| If you are not using Node, you can install the CLI globally. |
vimtor
reviewed
May 2, 2026
| Or if you are not using Node, you can install it globally. | ||
| You can then run the CLI with your package manager. | ||
|
|
||
| ```bash |
Collaborator
There was a problem hiding this comment.
thanks for your contribution!
can we check whether the docs support multiple tabs? maybe the starlight framework we're using already supports this, but i feel like it would be helpful to show how to run sst with pnpm, bun, and yarn
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
npm install sstfor Node projectsnpx sst devTesting
Closes #6851