Welcome to the SAM-E tool! In here you'll find all the code related to running and building SAM-E.
SAM-E is a tool that allows you to run AWS serverless architecture in your local environment. How it differs from other tools (i.e. Serverless framework) is that rather than building within a specific framework which translates to AWS cloudformation under-the-hood, SAM-E runs from your Cloudformation templates. This way there is no disconnect between your local environment (i.e. developers) and your live AWS environment (i.e. your devops).
If you're curious about the name, SAM-E stands for SAM (Serverless Application Model) - E (environment)... pronounced "Sammy".
| Crate | Description |
|---|---|
| cli | The command line interface for SAM-E. All features of the tool should be implemented via a variety of CLI commands & arguments. |
| invoker | The invoker is repsonsible for running the Lambda runtime among other things. For a full description please see the README in the invoker crate. |
| types | The types crate contains all the shared types between the invoker and the CLI. |
There are a number of dependencies you need before you can use the tool:
To use SAM-E, you'll need to install the CLI. There are a few options for you to do this:
# Install from source - note: you'll need to drop the binary in your path/bin directory if you want to use globally
cargo install --path sam-e-cli
# Use the build script
./build_cli.shOnce you have the CLI installed, follow the steps highlighted in the CLI README to get started.