Interactive Shell

The interactive shell allows developers to connect to their sandbox from their local IDE, auto sync code changes, stream logs, and manage the lifecycle of your application.

To enter the interactive shell, run the ampt command from your terminal. If you do not have the @ampt/cli NPM package installed globally, you can also run npm i -g @ampt/cli.

Additional flags can be passed to the ampt command to configure the behavior of the interactive shell.

• --seed: Seed data to your sandbox from your data.json file on initialization.
• --reseed: Enable automatic data reseeding when the data.json file is updated.
• --org: Overwrites the organization of the project in your current directory.
• --app: Overwrites the app of the project in your current directory.
• --region: Use the specified region when creating a new environment. This applies to the share and deploy commands, and when creating a new sandbox environment.

To exit the interactive shell, type exit or quit. The below commands are available in the interactive shell.

dev #

Starts the local development server in a child process, if a script named ampt:dev is defined in package.json.

share [NAME] [--container] #

Deploys the code AND data from your sandbox to a preview environment named NAME. If no NAME is provided, a randomly generated name will be created for you.

A preview environment is an ephemeral environment that you can use to easily share your work with others. Previews allow you to create a stable snapshots of your sandbox so that you can get feedback while continuing to make changes to your own version.

If a script named ampt:build is defined in package.json, it will be run before deploying.

Terminal
ampt  ›︎ share my-preview-env

deploy [NAME] [--container] #

Deploys the code from your sandbox to a permanent environment named NAME. If no NAME is provided, Interactive Shell prompts you to enter a name.

A permanent environment is a long-lived environment to host your app. Common names for permanent environments are prod, staging, qa, and dev.

If a script named ampt:build is defined in package.json, it will be run before deploying.

Terminal
ampt  ›︎ deploy prod

install [PACKAGENAME] #

Installs the specified npm package into your application, and syncs your sandbox once it's done. If you did not provide a package name, it'll simply install all your app's dependencies listed in package.json.

Install an npm dependency:

Terminal
ampt  ›︎ install @ampt/data

Install a dev dependency with --save-dev or -D:

Terminal
ampt  ›︎ install @11ty/eleventy -D

uninstall [PACKAGENAME] #

Uninstalls the specified npm package from your application, and syncs your sandbox once it's done.

Terminal
ampt  ›︎ uninstall @11ty/eleventy

run [SCRIPTNAME | FILEPATH][-- npm-arguments [-- script-arguments]] #

Runs the npm script ampt:<SCRIPTNAME> in your package.json or the FILEPATH of a JavaScript/TypeScript file locally on your sandbox. The script will have access to the selected stage's params, data, and storage.

See Running Scripts for more detailed usage information!

package.json
{
  "name": "my-ampt-app",
  ...
  "scripts": {
    "start": "ampt",
    "ampt:build": "eleventy" // Namespaced npm script
    ...
  },
  ...
}

Run ampt:build from your package.json:

Terminal
ampt  ›︎ run build

Run the local script ./scripts/migrate.js directly:

Terminal
ampt  ›︎ run ./scripts/migrate.js

import [FILENAME] [--overwrite] #

Imports data from the FILENAME in your local directory to your sandbox. If no FILENAME is provided, it will default to data.json. By default, the data will be merged with existing data. If you specify the -o or --overwrite flag, all data will be cleared and reseeded.

Terminal
ampt  ›︎ import data.json --overwrite

export [FILENAME] [--overwrite] #

Exports data from your sandbox to a JSON file named FILENAME in your current working directory. If no FILENAME is provided, it will default to data.json. If the FILENAME already exists, you can specify the -o or --overwrite flag to overwrite the existing file.

Terminal
ampt  ›︎ export my-exported-data.json

version #

Displays the current running version of the CLI.

Terminal
ampt  ›︎ version
v1.0.28

url #

Displays the current URL of your sandbox.

Terminal
ampt  ›︎ url→︎ https://{your-sandbox-url}.ampt.dev

open #

Opens the dashboard to the current app in your default browser.

Terminal
ampt  ›︎ openℹ︎ View your app in the dashboard
→︎ https://ampt.dev/{your-dashboard-link}

quit / exit or Ctrl/Cmd+C #

Terminates the interactive cloud shell and disconnects from your sandbox.

clear #

Clears the terminal screen.

Terminal
ampt  ›︎ clear

help #

Displays a simple help screen that shows all the available commands and their options.