Skip to content

Update Usage of README #374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DeviaVir merged 2 commits into from
Sep 13, 2017
Merged

Update Usage of README #374

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c251c2a
Update Usage of README
abetomo Sep 13, 2017
79f4348
Fix indentation
abetomo Sep 13, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 56 additions & 47 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,15 @@ Initializes the `event.json`, `context.json`, `.env`, `deploy.env` files, and `e
```
$ node-lambda setup --help

Usage: setup [options]
Usage: setup [options]

Options:
Sets up the .env file.

-h, --help output usage information

Options:
-h, --help output usage information
-j, --eventFile [event.json] Event JSON File
-x, --contextFile [context.json] Context JSON File
```

After running setup, it's a good idea to gitignore the generated `event.json` and `.env` files, as well as `.lambda`.
Expand Down Expand Up @@ -121,19 +125,20 @@ Bundles your application into a local zip file.
```
$ node-lambda package --help

Usage: package [options]
Usage: package|zip [options]

Options:
Create zipped package for Amazon Lambda deployment

-h, --help output usage information
-A, --packageDirectory [build] Local Package Directory
-I, --dockerImage [] Docker image for npm install
-n, --functionName [node-lambda] Lambda FunctionName
-H, --handler [index.handler] Lambda Handler {index.handler}
-e, --environment [staging] Choose environment {development, staging, production}
-x, --excludeGlobs [] Add a space separated list of file(type)s to ignore (e.g. "*.json .env")
-D, --prebuiltDirectory [] Prebuilt directory

Options:
-h, --help output usage information
-A, --packageDirectory [build] Local Package Directory
-I, --dockerImage [] Docker image for npm install
-n, --functionName [node-lambda] Lambda FunctionName
-H, --handler [index.handler] Lambda Handler {index.handler}
-e, --environment [development] Choose environment {dev, staging, production}
-x, --excludeGlobs [event.json] Space-separated glob pattern(s) for additional exclude files (e.g. "event.json dotenv.sample")
-D, --prebuiltDirectory [] Prebuilt directory
```

#### deploy
Expand All @@ -143,40 +148,44 @@ Bundles and deploys your application up to Amazon Lambda.
```
$ node-lambda deploy --help

Usage: deploy [options]

Options:

-h, --help output usage information
-e, --environment [staging] Choose environment {development, staging, production}
-a, --accessKey [your_key] AWS Access Key
-s, --secretKey [your_secret] AWS Secret Key
-P, --profile [your_profile] AWS Profile
-k, --sessionToken [your_token] AWS Session Token
-r, --region [us-east-1] AWS Region(s)
-n, --functionName [node-lambda] Lambda FunctionName
-H, --handler [index.handler] Lambda Handler {index.handler}
-o, --role [your_role] Amazon Role ARN
-m, --memorySize [128] Lambda Memory Size
-t, --timeout [3] Lambda Timeout
-d, --description [missing] Lambda Description
-u, --runtime [nodejs6.10] Lambda Runtime {nodejs6.10, nodejs4.3}
-p, --publish [false] This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation
-L, --lambdaVersion [custom-version] Lambda Version
-f, --configFile [] Path to file holding secret environment variables (e.g. "deploy.env")
-b, --vpcSubnets [] VPC Subnet ID(s, comma separated list) for your Lambda Function, when using this, the below param is also required
-g, --vpcSecurityGroups [] VPC Security Group ID(s, comma separated list) for your Lambda Function, when using this, the above param is also required
-Q, --deadLetterConfigTargetArn [] Lambda DLQ resource
-T, --tracingConfig [] Lambda tracing settings
-R, --retentionInDays [] CloudWatchLogs retentionInDays settings
-A, --packageDirectory [] Local package directory
-I, --dockerImage [] Docker image for npm install
-S, --eventSourceFile [event_sources.json] Path to file holding event source mapping variables (e.g. "event_sources.json")
-x, --excludeGlobs [] Add a space separated list of file(type)s to ignore (e.g. "*.json .env")
-D, --prebuiltDirectory [] Prebuilt directory
-z, --deployZipfile [] Deploy zipfile
-T, --deployTimeout [120000] Deploy Timeout
-G, --sourceDirectory [.] Path to lambda source Directory (e.g. "./some-lambda")
Usage: deploy [options]

Deploy your application to Amazon Lambda


Options:
-h, --help output usage information
-e, --environment [development] Choose environment {dev, staging, production}
-a, --accessKey [your_key] AWS Access Key
-s, --secretKey [your_secret] AWS Secret Key
-P, --profile [] AWS Profile
-k, --sessionToken [] AWS Session Token
-r, --region [us-east-1] AWS Region
-n, --functionName [node-lambda] Lambda FunctionName
-H, --handler [index.handler] Lambda Handler {index.handler}
-o, --role [your_amazon_role] Amazon Role ARN
-m, --memorySize [128] Lambda Memory Size
-t, --timeout [3] Lambda Timeout
-d, --description [missing] Lambda Description
-u, --runtime [nodejs6.10] Lambda Runtime
-p, --publish [false] Lambda Publish
-L, --lambdaVersion [] Lambda Function Version
-b, --vpcSubnets [] Lambda Function VPC Subnets
-g, --vpcSecurityGroups [] Lambda VPC Security Group
-K, --kmsKeyArn [] Lambda KMS Key ARN
-Q, --deadLetterConfigTargetArn [] Lambda DLQ resource
-T, --tracingConfig [] Lambda tracing settings
-R, --retentionInDays [] CloudWatchLogs retentionInDays settings
-A, --packageDirectory [build] Local Package Directory
-G, --sourceDirectory [] Path to lambda source Directory (e.g. "./some-lambda")
-I, --dockerImage [] Docker image for npm install
-f, --configFile [] Path to file holding secret environment variables (e.g. "deploy.env")
-S, --eventSourceFile [] Path to file holding event source mapping variables (e.g. "event_sources.json")
-x, --excludeGlobs [event.json] Space-separated glob pattern(s) for additional exclude files (e.g. "event.json dotenv.sample")
-D, --prebuiltDirectory [] Prebuilt directory
-T, --deployTimeout [120000] Deploy Timeout
-z, --deployZipfile [] Deploy zipfile
-y, --proxy [] Proxy server
```

## Custom Environment Variables
Expand Down