Getting Started

Installing

AssemblyLift provides a Command Line Interface (CLI) called asml. The CLI is primarily responsible for building & deploying your application.

The AssemblyLift CLI delegates to language-specific tools for compilation. For example, writing functions with Rust will require that you have installed Cargo.

You can install asml using cargo with:

$ cargo install assemblylift-cli

Running asml help will print the CLI version, as well as a list of commands:

$ asml help
asml 0.3.0
USAGE:
asml [SUBCOMMAND]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
SUBCOMMANDS:
bind Bind the application to the cloud backend
burn Destroy all infrastructure created by 'bind'
cast Build the AssemblyLift application
help Prints this message or the help of the given subcommand(s)
init Initialize a basic AssemblyLift application
make Make a new service or function
pack Pack artifacts for publishing
push Push artifacts to a registry
user User authentication & information

Getting an AWS Account

The default infrastructure provider for AssemblyLift is AWS Lambda + API Gateway, which require an Amazon AWS account.

Creating an account is free, and both AWS Lambda and Amazon API Gateway are free tier eligible.

Hello World!

You can create a new project with the init command. This will scaffold a basic project structure with a single service, containing a single function.

$ asml init --name myapp
$ tree myapp
myapp
├── assemblylift.toml
└── services
└── my-service
├── my-function
│   ├── Cargo.toml
│   └── src
│   └── lib.rs
└── service.toml

If you like, you can verify everything is working by building the project with cast and then deploying it with bind.

Project Structure

AssemblyLift projects and services are defined in TOML documents called manifests. Each project must have a manifest at the project root called assemblylift.toml, and each service must have a manifest at the service root called service.toml.

Each function is stored in a sub-directory under the service directory. Function directories are structured according to the given programming language.