Next.js · CLI scaffold

Next.js

One command scaffolds the webhook route, blog pages, components, and SQL schema, wired for your project automatically.

Overview

vellumup-init is VellumUp's own open-source CLI. It inspects your Next.js project and writes the webhook receiver, blog pages, and supporting files directly into it, no manual copying, no AI assistant required.

terminal

npx vellumup-init

Open source, MIT licensed, and published on npm. View on npm

Requirements

Next.js project (App Router for the full blog, Pages Router supports the webhook route only)
Node.js 18.3 or later
A PostgreSQL-compatible database for article storage (full blog mode only, Supabase by default)

What it generates

Running the command with no flags scaffolds a complete blog:

tree

your-project/
├── app/
│   ├── api/vellumup/route.ts     # webhook receiver
│   └── blog/
│       ├── page.tsx              # paginated blog index
│       └── [slug]/page.tsx       # article page
├── components/
│   ├── BlogPostLayout.tsx
│   ├── BlogSection.tsx
│   ├── BlogCard.tsx
│   ├── BlogKeyTakeaways.tsx
│   └── PillTableOfContents.tsx
├── lib/blog-theme.ts             # theming configuration
├── vellumup/articles.sql         # PostgreSQL schema
└── .env.local                    # environment variables

Pass --route-only to generate just the webhook receiver, SQL file, and secret placeholder, with no blog pages or components, for teams building their own blog UI.

CLI flags

All flags are optional. Running the command with none of them starts an interactive setup.

Flag	Effect
--yes	Non-interactive mode, accepts the defaults for every prompt
--route-only	Generates only the webhook route, SQL file, and secret, no blog pages or components
--lang <code>	Sets a language filter (e.g. en, fr) for the generated blog
--no-install	Writes the files but skips running your package manager
--help	Shows usage help, or --version for the installed version

How to connect

Once the files are generated, connect the webhook it created to your VellumUp account:

1
Copy your webhook secret
The CLI writes a placeholder secret to .env.local. Generate a real one from Integrations → Next.js in your VellumUp dashboard and paste it in.
2
Deploy your project
The webhook route needs a public HTTPS URL to receive events, deploy to Vercel or your usual host before registering the endpoint.
3
Register the endpoint
In VellumUp, go to Integrations → Next.js and register your deployed route's URL (yoursite.com/api/vellumup) to complete the connection.

The CLI optionally installs react-markdown and remark-gfm for full blog mode. It never installs @supabase/supabase-js for you, add that yourself if you're using Supabase.

Back to Docs