Skip to content
AtMyApp Docs
Go to AtMyApp
Open with AI

CLI Guide

@atmyapp/cli is the command-line workflow for local AtMyApp projects.

Terminal window
npm install -g @atmyapp/cli

Stores the project URL and CLI token for the current workspace.

Terminal window
atmyapp use --token cli_... --url https://edge.atmyapp.com/projects/your-project-id

Creates starter project files. The default output is atmyapp.schema.ts.

Terminal window
atmyapp init
atmyapp init --template empty
atmyapp init --template minimal
atmyapp init --template blog
atmyapp init --path atmyapp.schema.json
atmyapp init --force

The minimal and blog templates can also help create a project API key and print environment variables for runtime access.

Finds a canonical schema file, validates it, generates .ama/definitions.json, and uploads it unless --dry-run is set.

Terminal window
atmyapp migrate
atmyapp migrate --dry-run --verbose

The CLI looks for atmyapp.schema.* and ama.schema.*. If both exist, atmyapp.schema.* wins.

Upload local files to project storage:

Terminal window
atmyapp upload "content/**/*" --base-path content --commit "Update content"

Generate a placeholder file for a project storage path:

Terminal window
atmyapp generate --path content/settings.json