create-headroom

Scaffold a new Headroom CMS project.

Usage

npm create headroom my-cms

Or with npx:

npx create-headroom my-cms

The CLI will prompt for your sender email address (used for admin invitations and password resets), then generate a ready-to-deploy project.

What It Does

1. Prompts for your sender email (must be verified in AWS SES)
2. Copies the project template to my-cms/
3. Substitutes your project name and email into the config files
4. Runs pnpm install (falls back to npm install)

Generated Project Structure

my-cms/
├── sst.config.ts       # SST config — imports HeadroomCMS component
├── package.json         # Dependencies: headroom-cms + sst
├── tsconfig.json        # TypeScript config
├── sst-env.d.ts         # SST type declarations
├── .gitignore
└── scripts/
    ├── create-admin.sh  # Create a Cognito admin user
    └── get-token.sh     # Get a JWT token for API testing

The sst.config.ts is the main file you'll edit to configure your CMS. See the headroom-cms configuration reference for all available options.

Next Steps

cd my-cms

# Deploy to AWS
npx sst deploy --stage production

# Create your first admin user
./scripts/create-admin.sh [email protected] 'YourPassword123!'

After deploying, open the Admin URL from the deploy output and sign in.

License

PolyForm Noncommercial 1.0.0