L³ CLI

Command-line tool to create a new L³ application.

Dependencies

• Node.js

Installation

Install the command-line utility using NPM.

$ npm install -g @lambda-lambda-lambda/cli

Usage

Create a new L³ application

Usage: lambda-lambda-lambda create [options]

Options:
--name <value>          Application name (Example: restfulApiHandler)
--description <value>   Description
--prefix <path>         Request prefix (Example: /api) (default: "/")
--timeout <number>      Function timeout (in seconds) (default: "15")
--sdk-version <number>  AWS SDK for JavaScript version (default: "3")
--runtime <string>      Node.js Lambda runtime identifier (default: "nodejs20.x")
--asynchronous          Use asynchronous handler? (default: false)
-h, --help              display help for command

Install L³ middleware plugin

Usage: lambda-lambda-lambda install [options] <PluginName>

Arguments:
  PluginName            Plugin name (Example: BasicAuthHandler), list packages if undefined

Options:
-h, --help              display help for command

Supported runtimes

| Name | Identifier | SDK | Deprecation (Phase 1) | |------------|--------------|-----|-----------------------| | Node.js 20 | nodejs20.x | 3 | | | Node.js 18 | nodejs18.x | 3 | *See note below | | Node.js 16 | nodejs16.x | 2 | Mar 11, 2024 | | Node.js 14 | nodejs14.x | 2 | Nov 27, 2023 |

(*) While this Node release is currently supported in AWS Lambda, the underlying VS Code Dev Container is no longer supported by VS Code due to deprecated support older Linux build toolchains (glibc >= 2.28 and libstdc++ >= 3.4.2).

If you need to support this release update the devcontainer.json image to:

{
  "name": "restfulJsonApi",
  "image": "mcr.microsoft.com/devcontainers/typescript-node:0-18",

Developers

CLI options

Compile JavaScript sources from TypeScript to a distribution:

$ npm run compile

Compile and listen for changes (development mode):

$ npm run watch

Run ESLint on project sources:

$ npm run lint

Run Mocha integration tests:

$ npm run test

Contributions

If you fix a bug, or have a code you want to contribute, please send a pull-request with your changes. (Note: Before committing your code please ensure that you are following the TypeScript style guide)

Versioning

This package is maintained under the Semantic Versioning guidelines.

License and Warranty

This package is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.

lambda-lambda-lambda/cli is provided under the terms of the MIT license

Author

Marc S. Brooks