Repository: anomalyco/sst

Stars: 25846

CLAUDE.md Copy Chapter

Layout Copy Chapter

- platform/ — TS Pulumi components embedded via //go:embed (platform/platform.go:16)
- examples/ — sample apps
- cmd/sst/ — Go CLI entry, orchestrates everything
- cmd/sst/mosaic/ — live dev TUI
- pkg/server/ — JSON-RPC bridge for custom Pulumi dynamic providers (rpc/rpc.ts ↔ pkg/server)
- pkg/bus/ — pub/sub event bus
- sdk/js/ — runtime SDK for reading linked resources
- www/ — docs site (auto-generated from JSDoc comments in platform and extracted from the Go CLI)

Commands Copy Chapter

- Setup: bun run setup
- Build platform: bun run build:platform
- Build CLI: bun run build:cli
- Run CLI locally: cd examples/<app> && go run ../../cmd/sst <command>
- Go tests: bun run test:cli
- Typecheck: bun run typecheck
- Generate docs: bun run docs:generate
- Run docs locally: bun run docs:dev

Verification Copy Chapter

1. Build the platform
2. cd examples/<app> && bun install
3. go run ../../cmd/sst deploy
4. Verify with curl or AWS CLI
5. Don't clean up unless told to

README.md Copy Chapter

<p align="center">
<a href="https://sst.dev/">
<img alt="SST" src="https://raw.githubusercontent.com/sst/identity/main/variants/sst-full.svg" width="300" />
</a>
</p>

<p align="center">
<a href="https://sst.dev/discord"><img alt="Discord" src="https://img.shields.io/discord/983865673656705025?style=flat-square&label=Discord" /></a>
<a href="https://www.npmjs.com/package/sst"><img alt="npm" src="https://img.shields.io/npm/v/sst.svg?style=flat-square" /></a>
<a href="https://github.com/anomalyco/sst/actions/workflows/build.yml"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/anomalyco/sst/build.yml?style=flat-square&branch=dev" /></a>
</p>

---

Build full-stack apps on your own infrastructure.

Installation Copy Chapter

If you are using SST as a part of your Node project, we recommend installing it locally.

npm install sst

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

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

To install a specific version.

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 Copy Chapter

Get started with your favorite framework:

- Next.js
- Remix
- Astro
- API

Learn More Copy Chapter

Learn more about some of the key concepts:

- Live
- Linking
- Console
- Components

Contributing Copy Chapter

Here's how you can contribute:

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

Running Locally Copy Chapter

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

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

cd examples/aws-api
go run ../../cmd/sst <command>

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