archive-gh-me/serverless
1
0
Fork 0
mirror of https://github.com/serverless/serverless.git synced 2026-01-18 14:58:43 +00:00
Code Issues Projects Releases Wiki Activity

added docs for invoke-local

Browse Source
This commit is contained in:
Eslam A. Hefnawy 2016-10-25 19:41:49 +07:00
parent 0df8cbc60e
commit 4757a58bde
1 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/providers/aws/cli-reference/invoke.md
View File

@ -31,6 +31,21 @@ Default is `false`.
## Provided lifecycle events
- `invoke:invoke`
# Invoke Local
Invokes a function locally for testing and logs the output.
```bash
serverless invoke local --function functionName
```
## Options
- `--function` or `-f` The name of the function in your service that you want to invoke locally. **Required**.
- `--path` or `-p` The 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 an `event` and `context` properties to hold your mocked event and context data.
- `--data` or `-d` String data to be passed as an event to your function.
## Examples
### AWS
@ -57,4 +72,12 @@ serverless invoke --function functionName --stage dev --region us-east-1 --path
```
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.
the specified/deployed function.
#### Local function invocation
```bash
serverless invoke local --function functionName
```
This example will locally invoke your function.