CLI Scaffolder

npx create-nexaed-app                      # scaffold a new school app (default)
npx create-nexaed-app init my-school       # explicit init
npx create-nexaed-app doctor               # validate an existing app
npx create-nexaed-app upgrade              # upgrade @nexa-ed/* deps to @latest
npx create-nexaed-app skill                # install the Nexa-Ed Claude Code skill
npx create-nexaed-app telemetry on|off     # manage telemetry preference
npx create-nexaed-app help                 # print usage

# npx (no install required)
npx create-nexaed-app my-school
 
# pnpm
pnpm create nexaed-app my-school

npx create-nexaed-app my-school \
  --auth clerk \
  --features fileProcessing,payments \
  --ui shadcn \
  --email-tier tier-1-nexa \
  --api-key nxa_live_... \
  --pm pnpm
 
# or, without npm/npx installed:
pnpm dlx create-nexaed-app my-school \
  --auth clerk \
  --features fileProcessing,payments \
  --ui shadcn \
  --email-tier tier-1-nexa \
  --api-key nxa_live_... \
  --pm pnpm

NEXAED_AUTH=clerk NEXAED_FEATURES=convex,payments npx create-nexaed-app my-school

cd my-school
npx create-nexaed-app doctor
# or: pnpm dlx create-nexaed-app doctor

cd my-school
npx create-nexaed-app upgrade
# or: pnpm dlx create-nexaed-app upgrade

cd my-existing-app
npx create-nexaed-app skill
# or: pnpm dlx create-nexaed-app skill

my-school/
├── .claude/
│   └── skills/nexa-ed-sdk/  ← Claude Code skill (SKILL.md + reference/)
├── app/
│   ├── api/nexa/[...nexaed]/
│   │   └── route.ts        ← single catch-all route handler
│   ├── callback/route.ts   ← WorkOS sign-in callback  [workos only]
│   ├── dashboard/
│   │   └── page.tsx        ← main dashboard
│   ├── layout.tsx
│   ├── page.tsx            ← landing page (Nexa brand colours)
│   ├── providers.tsx
│   └── globals.css
├── convex/                  ← [convex feature only]
│   ├── schema.ts           ← Nexa schema fragments (payments / files / emails)
│   └── nexa.ts             ← @nexa-ed/convex function mounts — this is what
│                             makes `api.nexa.*` appear once codegen runs
├── lib/
│   ├── nexa.ts             ← SDK instance (pre-wired to your auth provider)
│   └── utils.ts            ← cn() helper  [shadcn only]
├── middleware.ts            ← auth route protection
├── components.json         ← shadcn/ui config  [shadcn only]
├── tailwind.config.ts
├── pnpm-workspace.yaml     ← build-script approvals + always-fresh @nexa-ed installs
├── .env.example            ← all required vars with inline comments
├── .env.local              ← API key pre-filled if you provided it
├── package.json
└── tsconfig.json

import { createNexa } from "@nexa-ed/next";
import { auth } from "@clerk/nextjs/server";
 
export const nexa = createNexa({
  apiKey: process.env.NEXA_API_KEY!,
  webhookSecret: process.env.NEXA_WEBHOOK_SECRET!,
  getUser: async () => {
    const { userId } = await auth();
    if (!userId) throw new Error("Unauthorized");
    return { userId };
  },
});

import { createNexa } from "@nexa-ed/next";
import { getServerSession } from "next-auth";
import { authOptions } from "@/lib/auth";
 
export const nexa = createNexa({
  apiKey: process.env.NEXA_API_KEY!,
  webhookSecret: process.env.NEXA_WEBHOOK_SECRET!,
  getUser: async () => {
    const session = await getServerSession(authOptions);
    if (!session?.user?.id) throw new Error("Unauthorized");
    return { userId: session.user.id };
  },
});

cd my-school && pnpm install

NEXA_API_KEY=nxa_live_...
NEXA_WEBHOOK_SECRET=nxa_live_...   # same value as NEXA_API_KEY

npx convex dev

pnpm dev