create-propelkit

Initialize a PropelKit SaaS project with AI PM.

Usage

npx create-propelkit
# or
npm init propelkit
# or
npx propelkit init

What It Does

1. Detects installed CLIs - Checks for Claude Code (required), Supabase CLI, and GitHub CLI
2. Asks about GitHub integration - If GitHub CLI is installed, asks whether to enable auto-push
3. Asks your scenario - Starting fresh or configuring an existing clone
4. Clones PropelKit - If starting fresh, clones the boilerplate
5. Launches Claude Code - Opens Claude Code in your project directory

Requirements

• Node.js 18+ - Required for running the CLI
• Claude Code - Required for the AI PM conversation

Optional CLIs

These are optional but enhance the experience:

• Supabase CLI - Enables automatic database migrations

  • Without it: SQL is shown inline for manual execution
  • Install: https://supabase.com/docs/guides/local-development/cli/getting-started

• GitHub CLI - Enables automatic repo creation and commits

  • Without it: Local commits only, you push manually
  • Install: https://cli.github.com/

After Launch

When Claude Code opens, type:

/propelkit:new-project

This starts the AI PM conversation to build your project.

What Gets Created

The AI PM conversation will create:

• .planning/PROJECT.md - Project context
• .planning/config.json - Workflow preferences + CLI availability + GitHub preference
• .planning/research/ - Domain research (optional)
• .planning/REQUIREMENTS.md - Scoped requirements
• .planning/ROADMAP.md - Phase structure
• .planning/STATE.md - Project memory

Tech Stack

PropelKit builds SaaS apps with:

• Next.js 15 (App Router)
• TypeScript (strict mode)
• Supabase (PostgreSQL + Auth + RLS)
• Razorpay (payments, INR)
• Resend (emails)
• Inngest (background jobs)
• shadcn/ui + Tailwind CSS

India-First

PropelKit is built for Indian developers:

• Razorpay payments (not Stripe)
• INR currency formatting
• GST calculation and invoicing
• Indian phone number validation

Development

cd packages/create-propelkit
npm install
node bin/cli.js

Release Process

Releases are automated via GitHub Actions when a version tag is pushed.

Prerequisites

Configure these repository secrets in GitHub:

1. GH_PAT: Personal Access Token with repo scope

   • Go to: https://github.com/settings/tokens
   • Generate new token (classic)
   • Scopes: repo (full control)
   • Add as repository secret: Settings > Secrets > Actions > New

2. NPM_TOKEN: npm access token

   • Go to: https://www.npmjs.com/settings/~/tokens
   • Generate new token: Automation
   • Add as repository secret

Creating a Release

1. Update version in packages/create-propelkit/package.json
2. Commit: git commit -am "chore: bump version to X.Y.Z"
3. Tag: git tag vX.Y.Z
4. Push: git push origin main --tags

The workflow will:

• Sync code to getpropelkit/pro repository
• Publish to npm as create-propelkit
• Create a GitHub release

Manual Verification

After release, verify:

npx create-propelkit@latest --version
npm info create-propelkit

License

MIT