create-smash-os

Scaffold a SmashOS AI workflow platform instance into any directory.

Usage

npx create-smash-os my-smash-os

Or without a name (interactive):

npx create-smash-os

What it does

1. Clones the latest SmashOS source from GitHub
2. Prompts for your environment variables (Supabase, GitHub App)
3. Creates .env.local with your values
4. Runs npm install
5. Prints next steps for Supabase schema push, GitHub App setup, and Vercel deployment

Prerequisites

• Node.js 18+
• A Supabase project (free tier works)
• A Vercel account (for deployment)
• A GitHub App (created during setup)

After scaffolding

cd my-smash-os

# 1. Push the database schema
npx supabase db push

# 2. Fill in GitHub App credentials in .env.local
#    (created during the wizard — GitHub App ID, Client ID, Client Secret, Private Key)

# 3. Start locally
npm run dev

# 4. Deploy
npx vercel --prod

GitHub App setup

During the wizard you'll be prompted for GitHub App credentials. Create your app at: github.com/settings/apps → New GitHub App

Required settings: | Field | Value | |---|---| | Callback URL | https://your-domain.vercel.app/auth/github-app/callback | | Post-install redirect | https://your-domain.vercel.app/dashboard/repos/new?installed=true | | Webhook | Disabled (enabled in later setup) | | Permissions | Contents (Read), Metadata (Read), Pull requests (Read & Write), Commit statuses (Read & Write) |

Environment variables

| Variable | Required | Description | |---|---|---| | SUPABASE_URL | ✅ | Your Supabase project URL | | SUPABASE_ANON_KEY | ✅ | Supabase anon/public key | | GITHUB_APP_ID | ⚙️ | GitHub App numeric ID | | GITHUB_APP_SLUG | ⚙️ | GitHub App URL slug (e.g. smash-os) | | GITHUB_CLIENT_ID | ⚙️ | GitHub App OAuth Client ID | | GITHUB_CLIENT_SECRET | ⚙️ | GitHub App OAuth Client Secret | | GITHUB_APP_PRIVATE_KEY | ⚙️ | GitHub App PEM private key (newlines as \n) | | GITHUB_WEBHOOK_SECRET | ⚙️ | Webhook verification secret |

⚙️ = Required for GitHub App integration (repo registration + context engine)