Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/anomalyco/sst/llms.txt

Use this file to discover all available pages before exploring further.

The SST CLI is available for macOS, Linux, and Windows (via WSL). You can install it locally in your project or globally on your system.

​
Local installation

If you’re using SST as part of a Node.js project, we recommend installing it locally. 
npm install sst
Then run SST commands using your package manager: 
npx sst deploy
Local installation ensures everyone on your team uses the same SST version.

​
Global installation

If you’re not using Node.js, you can install the CLI globally.

​
Quick install

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

​
Install a specific version

To install a specific version, set the VERSION environment variable: 
curl -fsSL https://sst.dev/install | VERSION=0.0.403 bash

​
Package managers

Install via Homebrew:
brew install sst/tap/sst
To upgrade:
brew upgrade sst
You might need to run brew upgrade sst before updating.

​
Manual installation

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

​
Verify installation

Verify that SST is installed correctly: 
sst version
This should output the installed version: 
SST 3.0.0

​
Upgrade

To upgrade to the latest version:
Update the package in your project:
npm update sst

​
Dependencies

SST automatically installs and manages its dependencies when you run commands. These include:
  • Pulumi — Used for infrastructure deployment
  • Bun — Used for building and running code
The first time you run an SST command, you’ll see: 
⠇  Installing pulumi...
⠇  Installing bun...
These are installed in your system’s SST directory and shared across all your projects.
You can see where SST stores its files by running sst version.

​
Environment variables

You can configure SST’s behavior using environment variables:

​
SST_STAGE

Set the default stage for all commands: 
export SST_STAGE=production
sst deploy
This is equivalent to: 
sst deploy --stage production

​
SST_PRINT_LOGS

Print detailed logs to the console: 
SST_PRINT_LOGS=1 sst deploy
Useful in CI/CD environments where you want to see all logs.

​
SST_TELEMETRY_DISABLED

Disable anonymous telemetry: 
export SST_TELEMETRY_DISABLED=1
Or: 
sst telemetry disable

​
NPM_REGISTRY

Use a custom npm registry for provider packages: 
NPM_REGISTRY=https://my-registry.com sst add aws

​
Configuration file

You can optionally specify a custom path to your config file: 
sst --config path/to/sst.config.ts deploy
This is useful in monorepos with multiple SST apps.

​
Next steps

Quickstart

Create your first SST app

CLI Reference

Explore all CLI commands

sst.config.ts

Learn about the config file

Providers

Add cloud providers