Serverless Framework Docs

#Print

Print your serverless.yml config file with all variables resolved.

If you're using Serverless Variables in your serverless.yml, it can be difficult to know if your syntax is correct or if the variables are resolving as you expect.

With this command, it will print the fully-resolved config to your console.

serverless print

#Options

  • format Print configuration in given format ("yaml", "json", "text"). Default: yaml
  • path Period-separated path to print a sub-value (eg: "provider.name")
  • transform Transform-function to apply to the value (currently only "keys" is supported)

#Examples:

Assuming you have the following config file:

service: my-service

custom:
  bucketName: test

provider:
  name: aws
  runtime: nodejs10.x
  stage: ${opt:stage, "dev"}

functions:
  hello:
    handler: handler.hello

resources:
  Resources:
    MyBucket:
      Type: AWS::S3::Bucket
      Properties:
        BucketName: ${self:custom.bucketName}

Using sls print will resolve the variables in provider.stage and BucketName.

$ sls print
service: my-service
custom:
  bucketName: test
provider:
  name: aws
  runtime: nodejs10.x
  stage: dev # <-- Resolved
functions:
  hello:
    handler: handler.hello
resources:
  Resources:
    MyBucket:
      Type: 'AWS::S3::Bucket'
      Properties:
        BucketName: test # <-- Resolved

This prints the provider name:

sls print --path provider.name --format text

And this prints all function names:

sls print --path functions --transform keys --format text

Have questions?

Head over to the forums to search for your questions and issues or post a new one.