Usage

Requires Bun. Run the scaffolder with:

bun create thexjs-app@latest

You'll be guided through interactive prompts:

• Project name — e.g. my-app
• Features — choose from Tailwind CSS, shadcn/ui, Auth, Content collections, and Hooks
• Install & git — confirm dependency install and git init

bun create thexjs-app@latest my-app
cd my-app
bun run dev

Your app runs at http://localhost:3000 with hot reload.

Features

The scaffolder ships a single lean base template. Every feature is optional and selected at prompt time (or via CLI flags).

| Feature | Adds | | ----------------- | ----------------------------------------------------------------------------------------------------- | | Tailwind CSS | Utility-first styling + the x dev/build Tailwind pipeline | | shadcn/ui | Accessible React components in src/components/ui (requires Tailwind) | | Auth | SQLite-backed demo sessions, /login and a protected /dashboard with middleware | | Content | Markdown/MDX with frontmatter in content/, auto-routed and indexed on /blog | | Hooks | @thexjs/hooks dependency — SSR-safe React hooks (debounce, media query, localStorage, forms, server actions) |

Enabling shadcn/ui automatically enables Tailwind CSS.

A generated project always includes a complete .gitignore, a self-contained tsconfig.json, and (by default) an initialized git repository.

CLI flags

Skips the interactive prompts — useful for scripting and CI:

bun create thexjs-app@latest my-app --tailwind --auth --content --shadcn

| Flag | Description | | ----------------- | --------------------------------------------- | | <name> | Project name (creates a directory named slug) | | --tailwind | Include Tailwind CSS | | --shadcn | Include shadcn/ui (implies --tailwind) | | --auth | Include demo auth | | --content | Include content collections | | --hooks | Include the @thexjs/hooks package | | --no-install | Skip bun install | | --no-git | Skip git init | | --dev | Start the dev server after install |

Development

cd packages/create-thexjs-app
bun install
bun run build           # build dist/index.js (tsup)
bun run build:watch     # rebuild on change

Run the built CLI locally:

node dist/index.js

The generator reads the base template from templates/base and optional feature addons from templates/addons/<feature>. Addons mirror the project root and are merged on top of the base template, so addon files can override base files (e.g. Tailwind's src/styles/globals.css).

License

MIT