@amplifyup/cli

CLI for working inside an AmplifyUp project. The command is amplifyup.

To start a new project, use create-amplifyup. That command adds this package as a devDependency. To add it yourself:

npm install -D @amplifyup/cli

Commands

amplifyup init --api-url http://localhost:3000 --site-id <site id>
amplifyup push

amplifyup init

Writes .amplifyup in the project root. It does not create an AmplifyUp site. Pass the site id you already have.

{
  "definitionsPath": "data",
  "apiUrl": "http://localhost:3000",
  "siteId": "<site id>"
}

| Flag | Effect | | --- | --- | | --api-url <url> | Orchestrator URL. Also read from AMPLIFYUP_API_URL. | | --site-id <id> | AmplifyUp site id. Also read from AMPLIFYUP_SITE_ID. | | --definitions-path <path> | Folder of entity and component JSON. Defaults to data. |

If .amplifyup is missing, or definitionsPath is omitted, the folder is data.

amplifyup push

Reads entities/ and components/ under definitionsPath and upserts them on the site from .amplifyup.

• POST /api/config/entities and PATCH /api/config/entities/:id
• POST /api/config/components and PUT /api/config/components/:componentId

Views are not pushed. apiUrl and siteId must already be set.

Requires Node 20 or newer.