create-amplifyup

create-amplifyup starts a new Next.js project. It is not a dependency of the finished app. After the app exists, use @amplifyup/cli for amplifyup init and amplifyup push.

Requires Node 20 or newer.

Create an app

npx create-amplifyup my-app
npx create-amplifyup my-app --example blog
npm create amplifyup my-app

npm create amplifyup is the same command (npm adds the create- prefix).

The empty starter is copied first. --example overlays an example from the Next.js starterkit (main by default). Template changes on that repo ship without a new release of create-amplifyup.

The new app gets @amplifyup/cli at latest as a devDependency. Dependencies are installed with whichever package manager invoked the command.

Flags

Flag	Effect
--example <name>	Overlay examples/<name> from the starterkit
--name <name>	npm package name (defaults to the directory name)
--ref <ref>	Starterkit branch, tag, or sha instead of main
--organization <id>	Sanity organization id, for examples that create a Sanity project
--project-name <name>	Sanity project name
--skip-sanity	Do not create a Sanity project
--skip-install	Do not install dependencies

Set AMPLIFYUP_STARTERKIT_PATH to a local starterkit checkout to scaffold from disk instead of GitHub.

Next step

Add a site in Amplify Up, then amplifyup init in the new app. Install the Node SDK if the starter did not already.