byol-cli

BYOL CLI

---

A command line interface on top of byol that lets you easily invoke lamda functions from the command line or from your code by starting your own lambda server.

Install

npm install -g @swydo/byol-cli

Commands

start (default)

Combine both start-lambda and start-api. Start an AWS-compatible Lambda server as well as a server mimicing API Gateway on the same port.

byol [-p PORT] [-s | --silent] [--keep-alive] [--template-path] [--env-path] [--profile] [--region] [--inspect]
byol start [-p PORT] [-s | --silent] [--keep-alive] [--template-path] [--env-path] [--profile] [--region] [--inspect]

With this server running you can call your Lambdas using the aws-sdk and your API over HTTP as usual.

start-lambda

Start an AWS-compatible Lambda server capable of running the functions defined in your template.yml. This is a replacement for sam local start-lambda.

byol start-lambda [-p PORT] [-s | --silent] [--keep-alive] [--template-path] [--env-path] [--profile] [--region] [--inspect]

With this server running you can call your Lambdas using the aws-sdk.

start-api

Starts a server mimicing API Gateway in proxy mode. Similar to sam local start-api you can call endpoints defined in your template file. Currently, only event sources on the function resource AWS::Serverless::Function are supported.

byol start-api [-p PORT] [-s | --silent] [--keep-alive] [--template-path] [--env-path] [--profile] [--region] [--inspect]

With the server running, call your API over HTTP as usual.

invoke

Invoke a function as defined in your template.yml. This is a replacement for sam local invoke.

byol invoke -f FunctionName -e {} [-s | --silent] [--template-path] [--env-path] [--profile] [--region] [--inspect] [--inspect-port]

Debugging

Debugging is supported by specifying --inspect Each concurrent function invocation runs in its own node process, so multiple debuggers can co-exist.

When running a server, connect your debugger at the application port + worker number. For instance, if your function runs at port 3000, connect your debugger to the first concurrent invocation at 3001, the second at 3002.

When invoking your function using invoke, connect at the default port (43210) or specify your own with --inspect-port.