README

---

Build full-stack apps on your own infrastructure.

 Installation

For JavaScript projects, install SST locally so the CLI version is tracked with your app. You can then run the CLI with the same package manager.

bash
npm install sst
 pnpm add sst
 bun add sst
 yarn add sst


If you are not using JavaScript, you can install the CLI globally.

bash
curl -fsSL https://sst.dev/install | bash


To install a specific version.

bash
curl -fsSL https://sst.dev/install | VERSION=0.0.403 bash


To use a package manager, check out our docs.

 Manually

Download the pre-compiled binaries from the releases page and copy to the desired location.

 Get Started

Get started with your favorite framework:

- Next.js
- Remix
- Astro
- API

 Learn More

Learn more about some of the key concepts:

- Live
- Linking
- Console
- Components

 Contributing

Here's how you can contribute:

- Help us improve our docs
- Find a bug? Open an issue
- Feature request? Submit a PR 

 Running Locally

Run bun run setup. You need Go and Bun installed.

Now you can run the CLI locally on any of the examples/ apps.

bash
cd examples/aws-api
go run ../../cmd/sst 


If you want to build the CLI binary, run bun run build:cli. This will create a sst binary that you can use.

For building the docs, run bun run docs:generate and bun run docs:dev.

---

Join our community Discord | YouTube | X.com