Standard Mode

Standard mode allows developers to run commands from your terminal without having to open an interactive session. Login is still required.

ampt login #

Logs the user in via the browser. You will need to verify the code you see in the browser.

Terminal
ampt loginℹ︎︎ 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.

ampt logout #

Logs the user out of the current session

Terminal
ampt logout

ampt reset [--yes] #

Resets your developer sandbox by wiping the data table, removing uploaded files from storage, clearing the code archive and any cached node_modules, and performing a full code re-sync from your local directory. Your sandbox URL stays the same.

This is useful when accumulated state from testing, running scripts, or iterating with AI coding agents causes your sandbox to drift from what a clean deploy would look like.

Running this command will ask for confirmation, or you can pass --yes to skip the prompt.

Terminal
ampt reset

You can use import to reseed data after a reset:

Terminal
ampt reset --yes
ampt import seed-data.json

ampt share [NAME] [--reset] [--container] #

Deploys the code AND data from your sandbox to a preview stage 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.

Use --reset to wipe the preview environment's data and storage, clear the code archive and cached node_modules, then redeploy a fresh copy from your sandbox. The preview URL stays the same. This is useful when a preview has accumulated its own state from testing and you want to push a clean copy.

Use --region <code> to specify the region where the preview environment will be created.

Terminal
ampt share my-preview-env

Share with a clean reset:

Terminal
ampt share my-preview-env --reset

ampt deploy [NAME] [--container] #

Deploys the code from your local directory to the provided permanent environment. If no NAME is provided, it will prompt you for an environment name.

A permanent environment is a long-lived stage/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.

Use --region <code> to specify the region where the new environment will be created.

Terminal
ampt deploy prod

ampt install [PACKAGENAME] #

Installs the specified npm package into your application. 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 --dev:

Terminal
ampt install @11ty/eleventy --dev

ampt uninstall [PACKAGENAME] #

Uninstalls the specified npm package from your application.

Terminal
ampt uninstall @11ty/eleventy

ampt 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

ampt stop #

Stops the local development server started by ampt run dev. Reports if no server is currently running.

Terminal
ampt stop

ampt 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

ampt 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

ampt params get [PARAM_NAME] #

Lists all parameters or shows details for a specific parameter. When called without a name, displays a table of all parameters. When called with a name, shows the parameter's value, description, and source (org-level, app-level, or environment override).

Terminal
ampt params get

Get details for a specific parameter:

Terminal
ampt params get MY_SECRET

ampt params set PARAM_NAME VALUE [--description "DESCRIPTION"] #

Sets an app-level parameter. Use --description to add a description.

Terminal
ampt params set API_KEY sk-abc123 --description "OpenAI key"

ampt params delete PARAM_NAME [--yes] #

Deletes an app-level parameter. Running this command will ask for confirmation, or you can pass --yes to skip the prompt.

Terminal
ampt params delete OLD_PARAM --yes

ampt whoami #

Displays the currently logged-in user, account details, and every organization you have access to along with your permission level in each. Useful for verifying your identity when switching between organizations or troubleshooting access issues.

Terminal
ampt whoami

ampt version #

Displays the running version of the CLI. -v flag is the short form for version.

Terminal
ampt version
v1.0.28

ampt url #

Displays the current URL of your sandbox.

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

ampt open #

Opens the dashboard to the current app in your default browser. ampt dashboard is an alias for this command.

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

ampt help #

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

ampt logs [--env NAME] [--follow] [--level LEVEL] [--type TYPE] [--search TEXT] [--json] #

Fetches historical logs from the specified environment, or streams live logs when --follow is passed.

Use --env <name> to target a specific environment. Use --follow (or -f) to stream logs in real-time — press Ctrl+C to stop.

Terminal
ampt logs --env prod

Stream logs in real-time:

Terminal
ampt logs --env prod --follow

Filter by log level and output raw JSON:

Terminal
ampt logs --env prod --level error --json

Filter by text:

Terminal
ampt logs --env prod --follow --search "payment"

Available flags:

ampt stages #

Lists all permanent stage environments for the current app in a table showing name, URL, region, last updated, and deployment status. Must be run inside an Ampt app directory.

Terminal
ampt stages

ampt delete [NAME] [--yes] #

Deletes a preview or sandbox environment by name. Running this command will ask for confirmation, or you can pass --yes to skip the prompt.

Terminal
ampt delete my-preview-env

Delete without a confirmation prompt:

Terminal
ampt delete my-preview-env --yes

ampt clone {ORG}/{APP} #

Clones an app's associated git repository into the current directory. Requires git to be installed and the app to have a connected repository.

Terminal
ampt clone my-org/my-app

ampt docs #

Opens the Ampt documentation in your default browser.

Terminal
ampt docs