Installation

Ampt lets developers write apps using their favorite tools, JavaScript frameworks, and npm packages, then automatically provisions, manages, and optimizes cloud resource by inferring requirements from the code.

Installation

Install & start the Ampt CLI

Navigate to an empty directory in your terminal and make sure you have Node.js v18+ and npm installed. Then run the following command to install and start Ampt.

Terminal
npm i -g @ampt/cli
ampt

The CLI will attempt to open a browser window to the Ampt dashboard. If your browser window doesn't open automatically, copy and paste the link provided in the CLI.

In the browser window, sign in or create a new Ampt account.

Terminal
ampt ℹ︎ You must login to proceeed.
ℹ︎ Your browser should open automatically.
ℹ︎ If not, open the following login url:
→︎ https://ampt.dev/activate?user_code=XXXX-XXXX
ℹ︎ Your confirmation code is: XXXX-XXXX
⚠︎ This code will expire in 15 minutes.

Confirm your device

Once signed in, you'll be asked to confirm that the code in the CLI matches the code in the browser.

Device Confirmation

Please confirm this is the code displayed on your Ampt CLI:

XXXX-XXXX

If you did not initiate this action or you do not recognize this device select cancel.

Cancel

Confirm

Go through the tutorial

Ampt provides an out-of-the-box interactive tutorial to help new users get accustomed to Ampt workflows. This is optional, but highly recommended.

If you started Ampt in an empty directory, you'll have a chance to use our preconfigured tutorial template. If you started Ampt in an existing project directory, or want to use a template, you can still access the tutorial from the CLI using the tutorial command.

Terminal
ampt 
? Would you like to start the tutorial?
ℹ︎ You've selected yes.
ℹ︎ Enter a name for your app
 ›︎ my-ampt-tutorial▊

Create a new app

When started in an empty directory, Ampt will ask if you want to create a new app. Select "Yes" from the menu.

If you want to migrate an existing Node.js project to Ampt, just start the CLI in the project's directory.

Terminal
ampt ? Would you like to create a new app?›︎ Yes
  No

Select a starter template

Ampt provides a set of preconfigured templates to quickly bootstrap your project.

Terminal
ampt 
? Would you like to create a new app?
ℹ︎ You've selected yes.
ℹ︎ Choose a template to generate.›︎ JavaScript API (Express)
  TypeScript API (Express)
  React starter app
  Astro Web Store
  NextJS Starter Template (v12)
  WebSockets starter template
  ...

Name your app

The app name will default to your directory name. You can rename it here.

Terminal
ampt ℹ︎ You've selected JavaScript API (Express).
ℹ︎ Enter a name for your app
 ›︎ my-cool-api ▊

Start coding!

Ampt generates the template code in your local directory, then spins up and connects to your isolated developer sandbox in the cloud.

Open your project directory in your favorite IDE and just start coding! Every time you save your work, your changes will be synced and deployed to your developer sandbox in less than a second.

Checkout the CLI documentation for more cool things you can do from the terminal. 🚀

Terminal
ampt ℹ︎ You've entered my-cool-api.
✔︎ Successfully generated app my-cool-api in this directory.✔︎ Connected to @org/app/username 
→︎ https://{your-unique-url}.ampt.app
 ›︎ ▊

Congratulations, now you're Ampt! 😉

Logs will be streamed directly into the interactive shell running in your terminal to give you immediate feedback. Plus, you can manage your parameters, view metrics, browse and update data, access blob storage, and much more using the Ampt Dashboard.

Getting Started

Core Concepts

Interfaces

Modules

Workflows

Frameworks

Guides

CLI Reference

Get started with Ampt!

The fastest way to get things done in the cloud!