Skip to content
Get packs

Guide · Open source

How to use SST: install, set up a project and deploy

Updated · written with AI from the project's own documentation and checked against our catalogue data

SST is an open-source command-line tool and set of components for building full-stack web applications and deploying them to infrastructure you control. It is released under the MIT licence and written in TypeScript. This guide shows you how to install it, where to start, and what the main concepts are, so you can decide whether it fits your project.

SSTanomalyco/sst · ★ 26.4k · MIT

Quick start

  1. 1Check prerequisites. Make sure Node.js or Bun is installed. If you are not using JavaScript, plan to use the global curl install instead.
  2. 2Install SST in your project. Run npm install sst, or use pnpm, bun or yarn, from your JavaScript project folder.
  3. 3Choose a framework guide. Pick Next.js, Remix, Astro or API from the README's Get Started list.
  4. 4Read the core concepts. Review the docs on Live, Linking, the Console and Components before you build.
  5. 5Define your app and its resources. Follow the chosen guide to describe your app's cloud resources alongside your code.

What you need before you install SST

SST is aimed at JavaScript and TypeScript developers. For installing into a JavaScript project you need Node.js or Bun, because the package can be installed with npm, pnpm, bun or yarn.

The README assumes you already know your way around frameworks and infrastructure. If you have no cloud or deployment experience, expect a steeper learning curve.

  • Node.js or Bun, for installing via npm, pnpm, bun or yarn
  • Go and Bun, only if you want to run the CLI from source

Install SST in a JavaScript project

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 you use for the project.

If you are not using JavaScript, you can install the CLI globally with the curl command. To install a specific version, the README shows a VERSION variable on the same command. For other package managers, the README points to the official CLI reference in the SST docs.

npm install sst # pnpm add sst # bun add sst # yarn add sst

Install the CLI globally for non-JavaScript projects

If your project is not JavaScript, install the CLI globally using the install script from the README. The README also describes a manual route: download the pre-compiled binaries from the releases page and copy them to the location you want.

  • Use the releases page on GitHub to download pre-compiled binaries manually
  • Check the SST CLI reference in the docs for package manager options
curl -fsSL https://sst.dev/install | bash

Pick a framework guide to start your first app

The README lists getting-started guides for Next.js, Remix, Astro and a plain API. Choose the one that matches the app you are building and follow it from the SST docs. Each guide walks through defining your app and its cloud resources.

SST also documents a few key concepts you will meet along the way: Live, Linking, the Console and Components. Read these once you have a working project.

  • Next.js: sst.dev/docs/start/aws/nextjs
  • Remix: sst.dev/docs/start/aws/remix
  • Astro: sst.dev/docs/start/aws/astro
  • API: sst.dev/docs/start/aws/api

Run SST from source if you want to contribute

If you want to work on SST itself, the README describes running the setup script with Bun, then running the CLI from an example app with Go. You can also build a CLI binary and generate the docs locally.

This route needs Go and Bun installed. Most users do not need it.

bun run setup cd examples/aws-api go run ../../cmd/sst <command> # To build the CLI binary: bun run build:cli

What people use it for

  • Building a full-stack Next.js app and defining its cloud resources in the same project
  • Deploying a Remix or Astro site to infrastructure you control
  • Running a plain API project with its resources defined in code
  • Giving a team one tool to manage app and cloud setup on their own infrastructure

Frequently asked questions

Is SST free to use?

SST is released under the MIT licence, as stated in the project's repository. Check the licence file in the repository for the full terms. Any cloud costs for the infrastructure you deploy to are separate.

What do I need to install SST?

For a JavaScript project, you need Node.js or Bun, and you can install SST with npm, pnpm, bun or yarn. Go and Bun are only needed if you run the CLI from source.

Can I use SST without JavaScript?

Yes. The README says that if you are not using JavaScript, you can install the CLI globally with the curl install script. You can also download pre-compiled binaries from the releases page.

Is SST good for beginners?

The README assumes familiarity with frameworks and infrastructure. Beginners with no cloud or deployment experience will find it hard going, so learn the basics of deployment first.

What are the alternatives to SST?

The project lists Serverless Framework, Pulumi, AWS CDK and Terraform as comparable tools. Each one defines cloud infrastructure, but they differ in language, scope and approach, so compare them against your own needs.

Should I use SST if I just want a static site host?

Probably not. The README centres on deploying to your own infrastructure, so if you only want a simple static host with no cloud account, pick a hosted platform instead.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

SST suits JavaScript and TypeScript developers who want their app and its cloud resources defined in one project and deployed to infrastructure they control. It is a poor fit for complete beginners, for people who only need a simple static host, or for teams that cannot keep up with a fast-moving release cycle. If you fall into the last group, compare it with Serverless Framework, Pulumi, AWS CDK or Terraform first.

Install options & downloads