mirror of
https://github.com/serverless/serverless.git
synced 2026-01-18 14:58:43 +00:00
2.1 KiB
2.1 KiB
Read this on the main serverless docs site
Invoke Local
This runs your code locally by emulating the AWS Lambda environment. Please keep in mind, it's not a 100% perfect emulation, there may be some differences, but it works for the vast majority of users. We mock the context with simple mock data.
serverless invoke local --function functionName
Options
--functionor-fThe name of the function in your service that you want to invoke locally. Required.--pathor-pThe path to a json file holding input data to be passed to the invoked function. This path is relative to the root directory of the service. The json file should have event and context properties to hold your mocked event and context data.--dataor-dString data to be passed as an event to your function. Keep in mind that if you pass both--pathand--data, the data included in the--pathfile will overwrite the data you passed with the--dataflag.
Examples
Local function invocation
serverless invoke local --function functionName
This example will locally invoke your function.
Local function invocation with data
serverless invoke --function functionName --data "hello world"
serverless invoke --function functionName --data '{"a":"bar"}'
Local function invocation with data from standard input
node dataGenerator.js | serverless invoke local --function functionName
Local function invocation with data passing
serverless invoke local --function functionName --path lib/data.json
This example will pass the json data in the lib/data.json file (relative to the root of the service) while invoking the specified/deployed function.