Serverless Framework Cheatsheet

Serverless Cheatsheet.md

Serverless Cheatsheet

Login

serverless login
sls login

Info

serverless info --stage STAGENAME --profile AWSPROFILE

Deploy

Deploy Project

serverless deploy --stage STAGENAME --profile AWSPROFILE

Deploy Function

serverless deploy function --function FUNCTIONNAME --stage STAGENAME --profile AWSPROFILE

Deploy Function Config ONLY

serverless deploy function --function FUNCTIONNAME --stage STAGENAME --profile AWSPROFILE --update-config

Run / Invoke

Run (Invoke) Function Locally

serverless invoke local --function FUNCTIONNAME --stage STAGENAME --profile AWSPROFILE
serverless invoke local --function FUNCTIONNAME --stage STAGENAME --region us-east-1 --profile AWSPROFILE

Run (Invoke) Function Locally (with data)

serverless invoke --function FUNCTIONNAME --stage STAGENAME --profile AWSPROFILE --data "hello world"
serverless invoke --function FUNCTIONNAME --stage STAGENAME --profile AWSPROFILE --region us-east-1 --path lib/data.json

Run (Invoke) Local Function

serverless invoke local --function FUNCTIONNAME

Run (Invoke) Local Function with data

serverless invoke local --function FUNCTIONNAME --data "hello world"
serverless invoke local --function FUNCTIONNAME --data '{"a":"bar"}'
serverless invoke local --function FUNCTIONNAME --path lib/data.json

Run (Invoke) Local Function, setting environment variables

serverless invoke local --function FUNCTIONNAME -e VAR1=value1
serverless invoke local --function FUNCTIONNAME -e VAR1=value1 -e VAR2=value2

Logs

serverless logs --function FUNCTIONNAME --stage STAGENAME --profile AWSPROFILE
serverless logs --function FUNCTIONNAME --stage STAGENAME --profile AWSPROFILE --startTime 5h
serverless logs --function FUNCTIONNAME --stage STAGENAME --profile AWSPROFILE --startTime 1469694264

Deploy List (Show deploy list versions and timestamps)

serverless deploy list --stage STAGENAME --profile AWSPROFILE

Rollback

Rollback a Deploy

serverless rollback --stage STAGENAME --profile AWSPROFILE --timestamp TIMESTAMP

Rollback a Function (to last version)

serverless rollback function --function FUNCTIONNAME --stage STAGENAME --profile AWSPROFILE

Serverless Config Info (serverless.yml)

serverless print --stage STAGENAME --profile AWSPROFILE

Flags Samples

--function or -f The name of the function in your service that you want to invoke. Required.
--stage or -s The stage in your service you want to invoke your function in.
--profile or -n Sets the AWS profile credentials you wish to use.
--region or -r The region in your stage that you want to invoke your function in.
--qualifier or -q The version number or alias to invoke your function in. Default is $LATEST.
--data or -d String data to be passed as an event to your function. By default data is read from standard input.
--raw Pass data as a raw string even if it is JSON. If not set, JSON data are parsed and passed as an object.
--path or -p The path to a json file with input data to be passed to the invoked function. This path is relative to the root directory of the service.
--type or -t The type of invocation. Either RequestResponse, Event or DryRun. Default is RequestResponse.
--log or -l If set to true and invocation type is RequestResponse, it will output logging data of the invocation. Default is false.