Skip to main content

SST Console

The SST Console is a web based dashboard to manage your SST apps — console.sst.dev

SST Console homescreen

note

Safari and Brave are now supported. Learn more about Working with Safari or Brave.

Features

The SST Console does a couple of things:

  • Display real-time logs from your Live Lambda Dev environment

    SST Console Local tab

  • Shows you all the deployed resources in your app

    SST Console Stacks tab

  • Allows you to invoke your functions and replay invocations

    SST Console Functions tab

info

Using the SST Console? Have some feedback or feature requests? Join us on Discord and head over to the #console channel.

Explorers

The SST Console also has dedicated tabs or explorers for specific resources.

API

SST Console API tab

The API explorer lets you make HTTP requests to any of the routes in your Api and ApiGatewayV1Api constructs. Set the headers, query params, request body, and view the function logs with the response.

DynamoDB

SST Console DynamoDB tab

The DynamoDB explorer allows you to query the DynamoDB tables in the Table constructs in your app. You can scan the table, query specific keys, create and edit items.

RDS

SST Console RDS tab

The RDS explorer allows you to manage the RDS instance created with the RDS constructs in your app. You can use the query editor to run queries. You can also use the migrations panel to view all of your migrations and apply them.

Buckets

SST Console Buckets tab

The Buckets explorer allows you to manage the S3 Buckets created with the Bucket constructs in your app. It allows you upload, delete, and download files. You can also create and delete folders.

GraphQL

SST Console GraphQL tab

The GraphQL explorer lets you query GraphQL endpoints created with the GraphQLApi and AppSyncApi constructs in your app.

Cognito

SST Console Cognito tab

The Cognito explorer allows you to manage the User Pools created with the Auth constructs in your app. It allows you create new users and delete existing users.

Modes

The SST Console operates in two separate modes; when it connects through the sst start or sst console command.

Connecting to Live Lambda Dev

When you run sst start, the SST CLI will print out a link to the console that can connect to your local environment.

$ npx sst start

==========================
Starting Live Lambda Dev
==========================

SST Console: https://console.sst.dev/acme/Jay
Debug session started. Listening for requests...

Connecting to deployed environments

Alternatively, you can run sst console and specify the stage you want the console to connect to.

$ npx sst console --stage prod

SST Console: https://console.sst.dev/acme/prod

This allows you look at logs in production and manage resources in production as well.

Working with Gitpod

If you are using Gitpod, you can use the Gitpod Local Companion app to connect to the sst start or sst console process running inside your Gitpod workspace.

The companion app runs locally and create a tunneled connection to your Gitpod workspace.

To get started:

  1. Install Gitpod Local Companion app
  2. Run the Companion app
  3. Naviate to console.sst.dev in the browser

Working with Safari or Brave

Certain browsers like Safari and Brave require the local connection between the browser and the sst start CLI to be running on HTTPS. SST integrates with mkcert to automatically generate a self-signed certificate. To set this up:

  1. Follow the mkcert installation steps.
  2. Run mkcert -install in your terminal.
  3. Restart your browser.
  4. Restart sst start and navigate to console.sst.dev in the browser.

How it works

The SST Console is a hosted single-page app. It uses the local credentials from the SST CLI (sst start or sst console) to make calls to AWS.

When the Console starts up, it gets the credentials from a local server that is run as a part of the SST CLI. It also gets some metadata from the app that's running locally. The local server only allows access from localhost and console.sst.dev.

The Console then uses these credentials to make calls to AWS using the AWS SDK. For some resources (like S3), the Console will proxy calls through your local CLI to get around the CORS restrictions in the browser.

info

The SST Console requires the SST CLI to be running (either sst start or sst console) to work.

When connected to sst start, the Console will display real-time logs from the local invocations of your functions. Whereas, when connected to sst console, it'll show you the CloudWatch logs for them instead.

The source for the console can be viewed in the SST GitHub repo.