CLI
Reference doc for the `sst` CLI.
The CLI helps you manage your SST apps.
With a package manager
You can also use a package manager to install the CLI.
-
macOS
The CLI is available via a Homebrew Tap, and as downloadable binary in the releases.
You might have to run
brew upgrade sst
, before the update. -
Linux
The CLI is available as downloadable binaries in the releases. Download the
.deb
or.rpm
and install withsudo dpkg -i
andsudo rpm -i
.For Arch Linux, it’s available in the aur.
-
Windows
The CLI is available via Scoop, and as a downloadable binary in the releases.
Usage
Once installed you can run the commands using.
The CLI takes a few global flags. For example, the deploy command takes the --stage
flag
Environment variables
You can access any environment variables set in the CLI in your sst.config.ts
file. For example, running:
Will let you access ENV_VAR
through process.env.ENV_VAR
.
Global Flags
stage
Type string
Set the stage the CLI is running on.
The stage is a string that is used to prefix the resources in your app. This allows you to have multiple environments of your app running in the same account.
If the stage is not passed in, then the CLI will:
- Use the username on the local machine.
- If the username is
root
,admin
,prod
,dev
,production
, then it will prompt for a stage name.
- If the username is
- Store this in the
.sst/stage
file and reads from it in the future.
This stored stage is called your personal stage.
verbose
Type boolean
Enables verbose logging for the CLI output.
help
Type boolean
Prints help for the given command.
Or for the global help.
Commands
init
Initialize a new project in the current directory. This will create a sst.config.ts
and sst install
your providers.
If this is run in a Next.js, Remix, Astro, or SvelteKit project, it’ll init SST in drop-in mode.
dev
Args
The command to runcommand?
Flags
Do not output function invocation logssilent
boolean
Run your app in development mode. Optionally, pass in a command to start your frontend as well.
You can also pass in a command to start your frontend with it.
To pass in a flag to your command, wrap it in quotes.
Dev mode does a few things:
- Starts a local server
- Watches your app config and re-deploys your changes
- Run your functions Live
- If you pass in a
command
, it’ll:- Load your linked resources in the environment
- And run the command
If sst dev
starts your frontend, it won’t print logs from your SST app. We do this to prevent your logs from being too noisy. To view your logs, you can run sst dev
in a separate terminal.
Starting multiple instances of sst dev
in the same project only starts a single server. Meaning that the second instance connects to the existing one.
This is different from SST v2, in that you needed to run sst dev
and sst bind
for your frontend.
deploy
Deploy your application. By default, it deploys to your personal stage.
Optionally, deploy your app to a specific stage.
add
Args
The provider to add.provider
Adds and installs the given provider. For example,
This command will:
- Installs the package for the AWS provider.
- Add
aws
to the globals in yoursst.config.ts
. - And, add it to your
providers
.
You can use any provider listed in the Pulumi Registry. The name of a provider comes from the URL of the provider in the Pulumi Registry.
For example, https://www.pulumi.com/registry/packages/aws/
is the URL of the AWS Clasic provider. So the name of the provider here is aws
.
By default, the latest version of the provider is installed. If you want to use a specific version, you can set it in your config.
install
Installs the providers in your sst.config.ts
. You’ll need this command when:
- You add a new provider to the
providers
orhome
in your config. - Or, when you want to install new providers after you
git pull
some changes.
Behind the scenes, it installs the packages for your providers and adds the providers to your globals.
If you don’t have a version specified for your providers in your sst.config.ts
, it’ll install their latest versions.
secret
secret set
Args
The name of the secret.name
The value of the secret.value
Set the value of the secret.
The secrets are encrypted and stored in an S3 Bucket in your AWS account. They are also stored in the package of the functions using the secret.
For example, set the sst.Secret
called StripeSecret
to 123456789
.
Optionally, set the secret in a specific stage.
To set something like an RSA key, you can first save it to a file.
Then set the secret from the file.
And make sure to delete the temp file.
secret load
Args
The file to load the secrets from.file
Load all the secrets from a file and set them.
The file needs to be in the dotenv or bash format of key-value pairs.
Optionally, set the secrets in a specific stage.
secret remove
Args
The name of the secret.name
Remove a secret.
For example, remove the sst.Secret
called StripeSecret
.
Optionally, remove a secret in a specific stage.
secret list
Lists all the secrets.
Optionally, list the secrets in a specific stage.
shell
Args
A command to run.command?
Run a command with all the resources linked to the environment.
For example, you can run a Node script and use the JS SDK to access all the linked resources in your app.
Now if you run a script.
It’ll have access to all the buckets from above.
If no command is passed in, it opens a shell session with the linked resources.
This is useful if you want to run multiple commands, all while accessing the linked resources.
remove
Removes your application. By default, it removes your personal stage.
Optionally, remove your app from a specific stage.
unlock
When you run sst deploy
, it acquires a lock on your state file to prevent concurrent deploys.
However, if something unexpectedly kills the sst deploy
process, or if you manage to run sst deploy
concurrently, the lock might not be released.
This should not usually happen, but it can prevent you from deploying. You can run sst unlock
to release the lock.
version
Prints the current version of the CLI.
upgrade
Args
A version to upgrade to.version?
Upgrade the CLI to the latest version. Or optionally, pass in a version to upgrade to.
telemetry
Subcommands
Manage telemetry settings.
SST collects completely anonymous telemetry data about general usage. We track:
- Version of SST in use
- Command invoked,
sst dev
,sst deploy
, etc. - General machine information, like the number of CPUs, OS, CI/CD environment, etc.
This is completely optional and can be disabled at any time.
telemetry enable
Enable telemetry.
telemetry disable
Disable telemetry.
refresh
Compares your local state with the state of the resources in the cloud provider. Any changes that are found are adopted into your local state.
This is useful for cases where you want to ensure that your local state is in sync with your cloud provider.