All tools/Serverless Framework

Serverless Framework

serverless

Makes it easy to use AWS Lambda and other managed cloud services to build applications that auto-scale and cost nothing when idle.

Detected by serverless, sls | macOS, Linux, Windows |www.serverless.com

Sync it serverless.toml

Sync rules

What travels, what stays, what never leaves

Serverless Framework in your home directory Every rule on this page, by file

{

"userId": "octocat",

"frameworkId": "1f0a2b3c-4d5e-11ee-b258-0242ac120002",machine-local

"trackingDisabled": true,

"enterpriseDisabled": false,

"auth": {

…

Each machine keeps its own copy of these.

auth.idTokenauth.refreshToken

Lifted into your secret store; the rest of the file syncs.

{

"userId": "octocat",

"frameworkId": "9c8b7a65-4321-11ee-9cd6-0242ac120002",machine-local

"trackingDisabled": false,

"enterpriseDisabled": false,

"auth": {

…

Each machine keeps its own copy of these.

auth.idTokenauth.refreshToken

Lifted into your secret store; the rest of the file syncs.

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/serverless.tomlThe file this page is generated from

id = "serverless"

name = "Serverless Framework"

homepage = "https://www.serverless.com/framework"

description = "Makes it easy to use AWS Lambda and other managed cloud services to build applications that auto-scale and cost nothing when idle."

icon = "SimpleIcons:serverless"

# `sls` is the framework's own short alias for the same binary, not a separate

# tool, so it is a second detect name rather than a second entry.

detect = ["serverless", "sls"]

# @serverless/utils/config.js builds the global config path from

# `.${baseFilename}rc`:

# getDefaultGlobalConfigPath() -> path.join(os.homedir(), '.serverlessrc')

# getHomeConfigGlobalConfigPath() -> path.join(os.homedir(), '.config', '.serverlessrc')

# getGlobalConfigPath() prefers ~/.serverlessrc when both exist and warns.

# There is also a project-local .serverlessrc in the CWD, which is not

# user-level and is not listed.

paths = ["~/.serverlessrc", "~/.config/.serverlessrc"]

exclude = []

# The file is not a whole-file secret: trackingDisabled, enterpriseDisabled and

# userId are settings worth carrying. Only the auth block is lifted out.

secret = []

# Read and rewritten per command; no resident process holds it.

side_effect = false

# Both spellings, or the token is only lifted out on a machine that happens to

# use the ~/.config location. `auth` is what `serverless login` writes:

# auth/login.js does `configUtils.set('auth', { refreshToken })` and

# auth/resolve-token.js does `configUtils.set({ auth: { idToken, refreshToken } })`.

# The name has no extension, so the parser has to be named explicitly.

[[secret_paths]]

file = ["~/.serverlessrc", "~/.config/.serverlessrc"]

format = "json"

match = { key_path = ["auth.idToken", "auth.refreshToken"] }

# frameworkId is a uuid.v1() minted once per installation

# (createDefaultGlobalConfig in @serverless/utils/config.js) and reported with

# telemetry. It identifies this install, so copying it to a second machine

# makes two machines claim to be one.

[[machine_lines]]

file = ["~/.serverlessrc", "~/.config/.serverlessrc"]

format = "json"

match = { key_path = ["frameworkId"] }

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/serverless. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these is generated from the same rules as this page. None of them splits frameworkId and frameworkId for you — that part is Otty’s own sync, or a template you write by hand.