# Getting Started

## Installing

### Prerequisites

AssemblyLift currently requires that you have the Rust toolchain installed. The easiest way to do this is via [rustup](https://rustup.rs/). In addition to the "default" toolchain targeting your system, you will also need to install the wasm32 toolchain with `rustup toolchain install wasm32-unknown-unknown`.

### Installing the CLI

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

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](https://aws.amazon.com/) account.

[Creating an account](https://portal.aws.amazon.com/billing/signup#/start) is free, and both AWS Lambda and Amazon API Gateway are [free tier eligible](https://aws.amazon.com/premiumsupport/knowledge-center/what-is-free-tier/).

## 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`.&#x20;

### Project Structure

AssemblyLift projects and services are defined in [TOML](https://toml.io) 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.


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.assemblylift.akkoro.io/learn-assemblylift/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
