Skip to content

Commit 7c2b65b

Browse files
abetomoReyPenaDeviaVir
authored
docs(readme): update help content of command (#585)
* Update README.md * restore line * docs(readme): update help content of command * Add `--packageManager` option. * README has also been updated because the display contents have changed due to the update of 'commander'. Co-authored-by: Reynaldo Pena <[email protected]> Co-authored-by: Chase <[email protected]>
1 parent 599bd76 commit 7c2b65b

File tree

1 file changed

+68
-70
lines changed

1 file changed

+68
-70
lines changed

‎README.md‎

Lines changed: 68 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ $ echo -e ".env\ndeploy.env\nevent.json\n.lambda" >> .gitignore
6464
##### Deploy env variables
6565

6666
```
67+
PACKAGE_MANAGER // (default: 'npm')
6768
AWS_ENVIRONMENT // (default: '')
6869
AWS_ENDPOINT // (default: '')
6970
CONFIG_FILE // (default: '')
@@ -109,23 +110,21 @@ Runs your Amazon Lambda index.js file locally. Passes `event.json` data to the A
109110

110111
```
111112
$ node-lambda run --help
112-
113-
Usage: run|execute [options]
113+
Usage: node-lambda run|execute [options]
114114
115115
Run your Amazon Lambda application locally
116116
117-
118117
Options:
119-
-h, --help output usage information
120-
-H, --handler [index.handler] Lambda Handler {index.handler}
121-
-j, --eventFile [event.json] Event JSON File
122-
-u, --runtime [nodejs14.x] Lambda Runtime
123-
-t, --timeout [3] Lambda Timeout
124-
-f, --configFile [] Path to file holding secret environment variables (e.g. "deploy.env")
125-
-x, --contextFile [context.json] Context JSON File
126-
-M, --enableRunMultipleEvents [true] Enable run multiple events
127-
-y, --proxy [] Proxy server
128-
--apiGateway Convert to API Gateway events
118+
-H, --handler [AWS_HANDLER] Lambda Handler {index.handler} (default: "index.handler")
119+
-j, --eventFile [EVENT_FILE] Event JSON File (default: "event.json")
120+
-u, --runtime [AWS_RUNTIME] Lambda Runtime (default: "nodejs14.x")
121+
-t, --timeout [AWS_RUN_TIMEOUT] Lambda Timeout (default: 3)
122+
-f, --configFile [CONFIG_FILE] Path to file holding secret environment variables (e.g. "deploy.env") (default: "")
123+
-x, --contextFile [CONTEXT_FILE] Context JSON File (default: "context.json")
124+
-M, --enableRunMultipleEvents [ENABLE_RUN_MULTIPLE_EVENTS] Enable run multiple events (default: true)
125+
-y, --proxy [PROXY] Proxy server (default: "")
126+
--apiGateway Convert to API Gateway events (default: false)
127+
-h, --help display help for command
129128
```
130129

131130
#### package
@@ -134,25 +133,26 @@ Bundles your application into a local zip file.
134133

135134
```
136135
$ node-lambda package --help
137-
138-
Usage: package|zip [options]
136+
Usage: node-lambda package|zip [options]
139137
140138
Create zipped package for Amazon Lambda deployment
141139
142-
143140
Options:
144-
-h, --help output usage information
145-
-A, --packageDirectory [build] Local Package Directory
146-
-I, --dockerImage [] Docker image for npm install
147-
-n, --functionName [node-lambda] Lambda FunctionName
148-
-H, --handler [index.handler] Lambda Handler {index.handler}
149-
-e, --environment [development] Choose environment {dev, staging, production}
150-
-x, --excludeGlobs [event.json] Space-separated glob pattern(s) for additional exclude files (e.g. "event.json dotenv.sample")
151-
-D, --prebuiltDirectory [] Prebuilt directory
152-
-m, --keepNodeModules [false] Keep the current node_modules and skip the npm install step
153-
-v, --dockerVolumes [] Additional docker volumes to mount. Each volume definition has to be separated by a space (e.g. "$HOME/.gitconfig:/etc/gitconfig $HOME/.ssh:/root/.ssh"
154-
--no-optionalDependencies Run `npm install` with `--no-optional`
155-
--packageManager [npm] Package manager use to install dependencies. (options: npm, yarn)
141+
--packageManager [PACKAGE_MANAGER] Package manager used to install dependencies (default: "npm", options: "npm", "yarn")
142+
-A, --packageDirectory [PACKAGE_DIRECTORY] Local Package Directory
143+
-I, --dockerImage [DOCKER_IMAGE] Docker image for npm ci (default: "")
144+
-n, --functionName [AWS_FUNCTION_NAME] Lambda FunctionName (default: "node-lambda")
145+
-H, --handler [AWS_HANDLER] Lambda Handler {index.handler} (default: "index.handler")
146+
-e, --environment [AWS_ENVIRONMENT] Choose environment {dev, staging, production} (default: "")
147+
-x, --excludeGlobs [EXCLUDE_GLOBS] Space-separated glob pattern(s) for additional exclude files (e.g.
148+
"event.json dotenv.sample") (default: "")
149+
-D, --prebuiltDirectory [PREBUILT_DIRECTORY] Prebuilt directory (default: "")
150+
-m, --keepNodeModules [KEEP_NODE_MODULES] Keep the current node_modules directory. (default: false)
151+
-v, --dockerVolumes [DOCKER_VOLUMES] Additional docker volumes to mount. Each volume definition has to be
152+
separated by a space (e.g. "$HOME/.gitconfig:/etc/gitconfig
153+
$HOME/.ssh:/root/.ssh") (default: "")
154+
--no-optionalDependencies Run `npm install` with `--no-optional`
155+
-h, --help display help for command
156156
```
157157

158158
#### deploy
@@ -161,52 +161,50 @@ Bundles and deploys your application up to Amazon Lambda.
161161

162162
```
163163
$ node-lambda deploy --help
164-
165-
Usage: deploy [options]
164+
Usage: node-lambda deploy [options]
166165
167166
Deploy your application to Amazon Lambda
168167
169-
170168
Options:
171-
-h, --help output usage information
172-
-e, --environment [development] Choose environment {dev, staging, production}
173-
-E, --endpoint [AWS_ENDPOINT] Choose endpoint (e.g. localstack, "http://127.0.0.1:4574") (default: "")
174-
-a, --accessKey [your_key] AWS Access Key
175-
-s, --secretKey [your_secret] AWS Secret Key
176-
-P, --profile [] AWS Profile
177-
-k, --sessionToken [] AWS Session Token
178-
-r, --region [us-east-1] AWS Region
179-
-n, --functionName [node-lambda] Lambda FunctionName
180-
-H, --handler [index.handler] Lambda Handler {index.handler}
181-
-o, --role [your_amazon_role] Amazon Role ARN
182-
-m, --memorySize [128] Lambda Memory Size
183-
-t, --timeout [3] Lambda Timeout
184-
-d, --description [missing] Lambda Description
185-
-u, --runtime [nodejs14.x] Lambda Runtime
186-
-p, --publish [false] Lambda Publish
187-
-L, --lambdaVersion [] Lambda Function Version
188-
-b, --vpcSubnets [] Lambda Function VPC Subnet IDs (comma delimited)
189-
-g, --vpcSecurityGroups [] Lambda VPC Security Group IDs (comma delimited)
190-
-K, --kmsKeyArn [] Lambda KMS Key ARN
191-
-Q, --deadLetterConfigTargetArn [] Lambda DLQ resource
192-
-c, --tracingConfig [] Lambda tracing settings
193-
-l, --layers [] Lambda Layers settings (e.g. "ARN1,ARN2[,..])" (default: "")
194-
-R, --retentionInDays [] CloudWatchLogs retentionInDays settings
195-
-G, --sourceDirectory [] Path to lambda source Directory (e.g. "./some-lambda")
196-
-I, --dockerImage [] Docker image for npm install
197-
-f, --configFile [] Path to file holding secret environment variables (e.g. "deploy.env")
198-
-S, --eventSourceFile [] Path to file holding event source mapping variables (e.g. "event_sources.json")
199-
-x, --excludeGlobs [event.json] Space-separated glob pattern(s) for additional exclude files (e.g. "event.json dotenv.sample")
200-
-D, --prebuiltDirectory [] Prebuilt directory
201-
-T, --deployTimeout [120000] Deploy Timeout
202-
-z, --deployZipfile [] Deploy zipfile
203-
-B, --deployUseS3 [] Use S3 to deploy.
204-
-i, --imageUri [] URI of a container image in the Amazon ECR registry. (default: "")
205-
-y, --proxy [] Proxy server
206-
-A, --tags [] Tags as key value pairs (e.g. "tagname1=tagvalue1,tagname2=tagvalue2") (default: "")
207-
--silent Silent or quiet mode (default: false)
208-
--no-optionalDependencies Run `npm install` with `--no-optional`
209-
--packageManager [npm] Package manager use to install dependencies. (options: npm, yarn)
169+
--packageManager [PACKAGE_MANAGER] Package manager used to install dependencies (default: "npm", options: "npm", "yarn")
170+
-e, --environment [AWS_ENVIRONMENT] Choose environment {dev, staging, production} (default: "")
171+
-E, --endpoint [AWS_ENDPOINT] Choose endpoint (e.g. localstack, "http://127.0.0.1:4574") (default: "")
172+
-a, --accessKey [AWS_ACCESS_KEY_ID] AWS Access Key
173+
-s, --secretKey [AWS_SECRET_ACCESS_KEY] AWS Secret Key
174+
-P, --profile [AWS_PROFILE] AWS Profile (default: "")
175+
-k, --sessionToken [AWS_SESSION_TOKEN] AWS Session Token (default: "")
176+
-r, --region [AWS_REGION] AWS Region (default: "us-east-1,us-west-2,eu-west-1")
177+
-n, --functionName [AWS_FUNCTION_NAME] Lambda FunctionName (default: "node-lambda")
178+
-H, --handler [AWS_HANDLER] Lambda Handler {index.handler} (default: "index.handler")
179+
-o, --role [AWS_ROLE] Amazon Role ARN (default: "missing")
180+
-m, --memorySize [AWS_MEMORY_SIZE] Lambda Memory Size (default: 128)
181+
-t, --timeout [AWS_TIMEOUT] Lambda Timeout (default: 60)
182+
-d, --description [AWS_DESCRIPTION] Lambda Description (default: "Command line tool for locally running and remotely deploying your node.js applications to Amazon Lambda.")
183+
-u, --runtime [AWS_RUNTIME] Lambda Runtime (default: "nodejs14.x")
184+
-p, --publish [AWS_PUBLISH] Lambda Publish (default: false)
185+
-L, --lambdaVersion [AWS_FUNCTION_VERSION] Lambda Function Version (default: "")
186+
-b, --vpcSubnets [AWS_VPC_SUBNETS] Lambda Function VPC Subnet IDs (comma delimited) (default: "")
187+
-g, --vpcSecurityGroups [AWS_VPC_SECURITY_GROUPS] Lambda VPC Security Group IDs (comma delimited) (default: "")
188+
-K, --kmsKeyArn [AWS_KMS_KEY_ARN] Lambda KMS Key ARN (default: "")
189+
-Q, --deadLetterConfigTargetArn [AWS_DLQ_TARGET_ARN] Lambda DLQ resource
190+
-c, --tracingConfig [AWS_TRACING_CONFIG] Lambda tracing settings (default: "")
191+
-l, --layers [AWS_LAYERS] Lambda Layers settings (e.g. "ARN1,ARN2[,..])" (default: "")
192+
-R, --retentionInDays [AWS_LOGS_RETENTION_IN_DAYS] CloudWatchLogs retentionInDays settings (default: "")
193+
-G, --sourceDirectory [SRC_DIRECTORY] Path to lambda source Directory (e.g. "./some-lambda") (default: "")
194+
-I, --dockerImage [DOCKER_IMAGE] Docker image for npm ci (default: "")
195+
-f, --configFile [CONFIG_FILE] Path to file holding secret environment variables (e.g. "deploy.env") (default: "")
196+
-S, --eventSourceFile [EVENT_SOURCE_FILE] Path to file holding event source mapping variables (e.g. "event_sources.json") (default: "")
197+
-x, --excludeGlobs [EXCLUDE_GLOBS] Space-separated glob pattern(s) for additional exclude files (e.g. "event.json dotenv.sample") (default: "")
198+
-D, --prebuiltDirectory [PREBUILT_DIRECTORY] Prebuilt directory (default: "")
199+
-T, --deployTimeout [DEPLOY_TIMEOUT] Deploy Timeout (default: 120000)
200+
-z, --deployZipfile [DEPLOY_ZIPFILE] Deploy zipfile (default: "")
201+
-B, --deployUseS3 [DEPLOY_USE_S3] Use S3 to deploy. (default: false)
202+
-i, --imageUri [IMAGE_URI] URI of a container image in the Amazon ECR registry. (default: "")
203+
-y, --proxy [PROXY] Proxy server (default: "")
204+
-A, --tags [AWS_TAGS] Tags as key value pairs (e.g. "tagname1=tagvalue1,tagname2=tagvalue2)" (default: "")
205+
--silent Silent or quiet mode (default: false)
206+
--no-optionalDependencies Run `npm install` with `--no-optional`
207+
-h, --help display help for command
210208
```
211209

212210
If you are deploying to a custom endpoint you may also need to pass in an access key/secret. For localstack these can be anything, but cannot be blank:

0 commit comments

Comments
 (0)