create-profound-app
v0.2.1
Published
Readme
create-profound-app
Scaffold a Next.js or TanStack Start app with Profound CMS (cms-renderer).
Usage
bunx create-profound-app <project-name>Interactive (TTY): you will be prompted to choose a framework and a template.
Non-interactive (CI): defaults to Next.js + Base unless you pass flags (see below).
bunx create-profound-app <project-name> --framework=next --template=base
bunx create-profound-app <project-name> --framework=tanstack --template=base
bunx create-profound-app <project-name> --framework=tanstack --template=docsShortcuts (skip the framework prompt — same CLI entry):
bunx create-profound-next <project-name>
bunx create-profound-tanstack <project-name>Shortcut detection reads npm_config_argv and the full process argv (not only the script basename), so it works when argv[1] is index.ts on Windows. If the framework prompt still appears, pass --framework=next|tanstack or set PROFOUND_DEFAULT_FRAMEWORK to next or tanstack for that run.
cd <project-name>
bun devbunx create-profound-app <project-name> --no-installEnvironment Variables
Create a .env or .env.local (see each template’s .env.example):
PROFOUND_API_KEY=your_api_key
NEXT_PUBLIC_PROFOUND_WEBSITE_ID=your_website_id
NEXT_PUBLIC_CMS_API_URL=https://cms.dev.tryprofound.com
NEXT_PUBLIC_BUNNY_CDN_URL="https://cms-profound.b-cdn.net"TanStack Templates
- Base and Docs include a CMS catch-all route powered by
cms-renderer’s parametric routing helper (cms-renderer/lib/parametric-route).
Commands (generated app)
| Command | Description |
| ----------------------- | ---------------------------------- |
| bun dev | Start development server |
| bun build | Production build |
| bun generate-schemas | Sync Zod schemas from the CMS |
generate-schemas
bun generate-schemasRequires NEXT_PUBLIC_CMS_API_URL and NEXT_PUBLIC_PROFOUND_WEBSITE_ID. Re-run when you change content models in the CMS.
