Installation

Prerequisites

Before you begin, make sure you have:

Create Your Project

Run the scaffolding CLI:

npx create-goon-app my-saas

You'll be prompted to:

  1. •Enter your license key (from your purchase confirmation email)
  2. •Choose a database provider - Neon (recommended), Supabase, PlanetScale, or SQLite
  3. •Select optional modules - Blog, AI routes, Admin dashboard, Waitlist

The CLI will create your project, install dependencies, and set up the initial configuration.

Non-Interactive Mode

For CI/CD or AI agents, skip the prompts:

npx create-goon-app my-saas \
  --key YOUR_LICENSE_KEY \
  --db neon \
  --features blog,admin \
  --yes

The goon CLI

The goon CLI is built into every scaffolded project. There is no separate package to install globally. After npm install, the CLI is available as a local binary:

npx goon setup payments

You can also run goon directly since it is registered in your project's package.json bin field.

Verify Installation

Navigate to your project and start the dev server:

cd my-saas
npm run dev

Open http://localhost:3000. You should see the marketing landing page.

What Just Happened?

The scaffolder created a complete Next.js project with:

my-saas/
ā”œā”€ā”€ src/
│   ā”œā”€ā”€ app/           # Pages and API routes
│   ā”œā”€ā”€ components/    # UI + marketing components
│   ā”œā”€ā”€ config/        # App configuration
│   └── lib/           # Auth, DB, payments, email
ā”œā”€ā”€ content/           # Blog MDX files
ā”œā”€ā”€ drizzle/           # Database migrations
ā”œā”€ā”€ tests/             # E2E tests
ā”œā”€ā”€ .env               # Environment variables
ā”œā”€ā”€ .goon/             # CLI manifest and rules
└── package.json

Next Steps