Skip to content

Update README (remove --endpoint of run subcommand, add --endpoint of deploy subcommand) - #514

Merged
DeviaVir merged 4 commits into
motdotla:masterfrom
inokappa:remove-endpoint-option-for-readme
Feb 12, 2020
Merged

Update README (remove --endpoint of run subcommand, add --endpoint of deploy subcommand)#514
DeviaVir merged 4 commits into
motdotla:masterfrom
inokappa:remove-endpoint-option-for-readme

Conversation

@inokappa

@inokappainokappa commented Dec 26, 2019

Copy link
Copy Markdown
Contributor

Hi

I removed --endpoint of run subcommand.
Because the --endpoint option does not exist in the run subcommand.

$ ./node_modules/node-lambda/bin/node-lambda --version
0.14.0
$ ./node_modules/node-lambda/bin/node-lambda run --help
Usage: run|execute [options]
Run your Amazon Lambda application locally
Options:
-H, --handler [AWS_HANDLER] Lambda Handler {index.handler} (default: "index.handler")
-j, --eventFile [EVENT_FILE] Event JSON File (default: "event.json")
-u, --runtime [AWS_RUNTIME] Lambda Runtime (default: "nodejs10.x")
-t, --timeout [AWS_RUN_TIMEOUT] Lambda Timeout (default: 3)
-f, --configFile [CONFIG_FILE] Path to file holding secret environment variables (e.g. "deploy.env") (default: "")
-x, --contextFile [CONTEXT_FILE] Context JSON File (default: "context.json")
-M, --enableRunMultipleEvents [ENABLE_RUN_MULTIPLE_EVENTS] Enable run multiple events (default: true)
-y, --proxy [PROXY] Proxy server (default: "")
-h, --help output usage information

And, the --endpoint option was missing from the deploy subcommand,

$ ./node_modules/node-lambda/bin/node-lambda deploy --help
Usage: deploy [options]
Deploy your application to Amazon Lambda
Options:
-e, --environment [AWS_ENVIRONMENT] Choose environment {dev, staging, production} (default: "")
-E, --endpoint [AWS_ENDPOINT] Choose endpoint (e.g. localstack, "http://127.0.0.1:4574") (default: "")
-a, --accessKey [AWS_ACCESS_KEY_ID] AWS Access Key (default: "")
-s, --secretKey [AWS_SECRET_ACCESS_KEY] AWS Secret Key (default: "")
-P, --profile [AWS_PROFILE] AWS Profile (default: "yamap-kawahara.yohei")
-k, --sessionToken [AWS_SESSION_TOKEN] AWS Session Token (default: "")
-r, --region [AWS_REGION] AWS Region (default: "ap-northeast-1")
-n, --functionName [AWS_FUNCTION_NAME] Lambda FunctionName (default: "lambda-cloudwatch-slack")
-H, --handler [AWS_HANDLER] Lambda Handler {index.handler} (default: "index.handler")
-o, --role [AWS_ROLE] Amazon Role ARN (default: "your_amazon_role")
-m, --memorySize [AWS_MEMORY_SIZE] Lambda Memory Size (default: "128")
-t, --timeout [AWS_TIMEOUT] Lambda Timeout (default: "3")
-d, --description [AWS_DESCRIPTION] Lambda Description (default: "Better Slack notifications for AWS CloudWatch")
-u, --runtime [AWS_RUNTIME] Lambda Runtime (default: "nodejs10.x")
-p, --publish [AWS_PUBLISH] Lambda Publish (default: false)
-L, --lambdaVersion [AWS_FUNCTION_VERSION] Lambda Function Version (default: "")
-b, --vpcSubnets [AWS_VPC_SUBNETS] Lambda Function VPC Subnets (default: "")
-g, --vpcSecurityGroups [AWS_VPC_SECURITY_GROUPS] Lambda VPC Security Group (default: "")
-K, --kmsKeyArn [AWS_KMS_KEY_ARN] Lambda KMS Key ARN (default: "")
-Q, --deadLetterConfigTargetArn [AWS_DLQ_TARGET_ARN] Lambda DLQ resource
-c, --tracingConfig [AWS_TRACING_CONFIG] Lambda tracing settings (default: "")
-l, --layers [AWS_LAYERS] Lambda Layers settings (e.g. "ARN1,ARN2[,..])" (default: "")
-R, --retentionInDays [AWS_LOGS_RETENTION_IN_DAYS] CloudWatchLogs retentionInDays settings (default: "")
-G, --sourceDirectory [SRC_DIRECTORY] Path to lambda source Directory (e.g. "./some-lambda") (default: "")
-I, --dockerImage [DOCKER_IMAGE] Docker image for npm install (default: "")
-f, --configFile [CONFIG_FILE] Path to file holding secret environment variables (e.g. "deploy.env") (default: "")
-S, --eventSourceFile [EVENT_SOURCE_FILE] Path to file holding event source mapping variables (e.g. "event_sources.json") (default: "")
-x, --excludeGlobs [EXCLUDE_GLOBS] Space-separated glob pattern(s) for additional exclude files (e.g. "event.json dotenv.sample") (default: "event.json")
-D, --prebuiltDirectory [PREBUILT_DIRECTORY] Prebuilt directory (default: "")
-T, --deployTimeout [DEPLOY_TIMEOUT] Deploy Timeout (default: 120000)
-z, --deployZipfile [DEPLOY_ZIPFILE] Deploy zipfile (default: "")
-B, --deployUseS3 [DEPLOY_USE_S3] Use S3 to deploy. (default: false)
-y, --proxy [PROXY] Proxy server (default: "")
-h, --help output usage information

Please confirm 🙏
Regards.

Yohei

@inokappainokappa changed the title Remove --endpoint of run subcommandUpdate README (remove --endpoint of run subcommand, add -endpoint of deploy subcommand)Dec 26, 2019
Comment threadREADME.md
-z, --deployZipfile [] Deploy zipfile
-B, --deployUseS3 [] Use S3 to deploy.
-y, --proxy [] Proxy server
-A, --tags []'Tags as key value pairs (e.g. "tagname1=tagvalue1,tagname2=tagvalue2") (default: "")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you mean to drop tags?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DeviaVir

I was not going to remove the --tags option. That is my mistake.
I'm Sorry.

@inokappainokappa changed the title Update README (remove --endpoint of run subcommand, add -endpoint of deploy subcommand)Update README (remove --endpoint of run subcommand, add --endpoint of deploy subcommand)Dec 27, 2019
@DeviaVir
DeviaVir merged commit 4fd66c9 into motdotla:masterFeb 12, 2020
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@inokappa@DeviaVir