> For the complete documentation index, see [llms.txt](https://docs.opensoutheners.com/oss/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.opensoutheners.com/oss/lambdary/readme.md).

# Introduction

A local development server for AWS Lambda functions that runs each function on the same runtimes AWS uses.

**Lambdary** is a local development server for AWS Lambda functions. Point it at a folder of function directories and get one local HTTP server that runs each function on the same runtimes AWS uses, through AWS's own [Runtime Interface Emulator](https://github.com/aws/aws-lambda-runtime-interface-emulator): in Docker when you have it, on your host runtimes when you don't.

```
$ lambdary dev
lambdary dev server listening on http://127.0.0.1:8000
backend: container (docker)

  api     /api     (nodejs22.x)
  worker  /worker  (python3.13)
```

Lambdary does not reimplement Lambda. It drives your code through AWS's own emulator and speaks AWS's own APIs, so the AWS CLI and every AWS SDK work against it unchanged.

## Features

* **Zero-config discovery** -- every function directory under your project root is found from its `.lambda.yml` or project file (`package.json`, `go.mod`, `requirements.txt`, ...).
* **Function URL routes** -- `http://localhost:8000/<function>/...` arrives in your handler as a real Lambda Function URL / API Gateway v2 event.
* **AWS-compatible invoke API** -- `aws lambda invoke --endpoint-url http://127.0.0.1:8000` works as is.
* **Two execution backends** -- AWS's official base images in Docker, Podman, Finch or nerdctl, or your host runtimes when no container runtime is around.
* **Hot reload** -- save a file and only that function restarts; config edits reconfigure the server live.
* **Go builds** -- Go functions are built for you on every start, no hand-built `bootstrap`.
* **Layers** -- layer version ARNs and local directories merged into `/opt`, as on AWS.
* **Versions and aliases** -- `publish-version`, `create-alias` and weighted canaries, locally.
* **SQS queues and schedules** -- a local SQS API, event source mappings with `ReportBatchItemFailures` and dead-letter queues, and EventBridge `rate()`, `cron()` and `at()` schedules.
* **Sample events** -- `lambdary invoke worker --event sqs` builds an SQS, S3, schedule or API Gateway event for you.
* **Logs, metrics and health** -- `lambdary logs`, a metrics summary, CloudWatch `GetMetricData`, and a health endpoint for Compose.
* **Docker Compose image** -- `ghcr.io/open-southeners/lambdary` runs the dev server next to the rest of your stack.

## Requirements

* Linux or macOS.
* For the container backend: Docker, Podman, Finch or nerdctl.
* For the process backend: the runtimes your functions use (`node`, `python3`, `ruby`, ...), plus `git` and `go` once, to build AWS's emulator when the binary does not already carry it.
* For Go functions: `go` on your `PATH`.

## Quick start

```sh
brew install open-southeners/tap/lambdary

mkdir my-functions && cd my-functions
lambdary init api
lambdary dev
curl http://127.0.0.1:8000/api
```

Then head to the [Installation](https://docs.opensoutheners.com/oss/lambdary/getting-started/installation.md) guide for every way to install Lambdary, or to the [Quick Start](https://docs.opensoutheners.com/oss/lambdary/getting-started/quick-start.md) for a short tour.

## Further reading

* [`DESIGN.md`](https://github.com/open-southeners/lambdary/blob/main/DESIGN.md) documents the architecture.
* [`CHANGELOG.md`](https://github.com/open-southeners/lambdary/blob/main/CHANGELOG.md) tracks user-facing changes.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.opensoutheners.com/oss/lambdary/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
