create-amplifyup

Scaffold an AmplifyUp Next.js project from the starterkit.

This package is for starting a project. It is not a dependency of the app. After the app exists, use @amplifyup/cli for amplifyup init and amplifyup push.

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 inserts the create- prefix and runs this package.

The empty starter is copied first. --example overlays examples/<name> from the starterkit: its definitions folder, sanity/ when present, and src/. The starterkit is always main of amplifyup/starterkit-nextjs, so template changes ship without a new release of this package. --ref downloads a branch, tag, or sha instead.

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

| Flag | Effect | | --- | --- | | --example <name> | Overlay examples/<name> from the starterkit | | --name <name> | npm package name for the new app (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.

Requires Node 20 or newer.