create-edgebase 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 melodysdreamj
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,147 @@
+<h1 align="center">create-edgebase</h1>
+
+<p align="center">
+  <b>Bootstrap a new EdgeBase project</b><br>
+  Scaffold the project, install dependencies, and start local development in one command
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/create-edgebase"><img src="https://img.shields.io/npm/v/create-edgebase?color=brightgreen" alt="npm"></a>&nbsp;
+  <a href="https://edgebase.fun/docs/getting-started/quickstart"><img src="https://img.shields.io/badge/docs-quickstart-blue" alt="Docs"></a>&nbsp;
+  <a href="https://github.com/edge-base/edgebase/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT License"></a>
+</p>
+
+<p align="center">
+  <a href="https://edgebase.fun/docs/getting-started/quickstart"><b>Quickstart</b></a> ·
+  <a href="https://edgebase.fun/docs/cli"><b>CLI Overview</b></a> ·
+  <a href="https://edgebase.fun/docs/cli/workflows"><b>CLI Workflows</b></a>
+</p>
+
+---
+
+`create-edgebase` is the package behind:
+
+```bash
+npm create edgebase@latest
+```
+
+It wraps the EdgeBase CLI and does the first-run setup for you:
+
+1. scaffold a new EdgeBase project
+2. install local project dependencies
+3. start local development unless you opt out
+
+> Beta: the bootstrap flow is usable today, but some templates and defaults may still evolve before general availability.
+
+## No Manual Install Required
+
+You normally do **not** install this package directly.
+
+Use it through npm create:
+
+```bash
+npm create edgebase@latest my-app
+```
+
+## Documentation Map
+
+- [Quickstart](https://edgebase.fun/docs/getting-started/quickstart)
+  First-run setup for a new EdgeBase project
+- [CLI Overview](https://edgebase.fun/docs/cli)
+  What the local CLI covers once the project exists
+- [CLI Workflows](https://edgebase.fun/docs/cli/workflows)
+  Common flows after scaffolding
+
+## For AI Coding Assistants
+
+This package ships with an `llms.txt` file for AI-assisted scaffolding.
+
+You can find it:
+
+- after install: `node_modules/create-edgebase/llms.txt`
+- in the repository: [llms.txt](https://github.com/edge-base/edgebase/blob/main/packages/create-edgebase/llms.txt)
+
+Use it when you want an agent to:
+
+- choose the correct bootstrap command
+- understand the `--no-dev` and `--no-open` flags
+- scaffold EdgeBase into an existing repo safely
+- avoid confusing `create-edgebase` with the runtime CLI package
+
+## Quick Start
+
+### Create a dedicated EdgeBase project
+
+```bash
+npm create edgebase@latest my-app
+```
+
+### Add EdgeBase inside an existing frontend project
+
+```bash
+cd your-frontend-project
+npm create edgebase@latest edgebase
+```
+
+That layout is recommended, not required. You can still keep EdgeBase in a separate repo or choose a different subdirectory name.
+
+## Flags
+
+### Skip auto-starting development
+
+```bash
+npm create edgebase@latest my-app -- --no-dev
+```
+
+### Prevent the browser from opening during `dev`
+
+```bash
+npm create edgebase@latest my-app -- --no-open
+```
+
+### Skip dependency install in automation
+
+```bash
+EDGEBASE_CREATE_SKIP_INSTALL=1 npm create edgebase@latest my-app -- --no-dev
+```
+
+## What Gets Created
+
+The scaffold sets up an EdgeBase project with the local CLI already wired in.
+
+Typical outputs include:
+
+- `edgebase.config.ts`
+- `functions/`
+- `package.json` with local EdgeBase dev dependencies and scripts
+- `.gitignore` entries for local secrets and generated files
+- local runtime metadata under `.edgebase/` during development and deploy flows
+
+If the target directory already contains `package.json` or `.gitignore`, the scaffold merges EdgeBase-specific entries instead of blindly replacing the file.
+
+## What Happens Next
+
+After scaffolding, the usual next step is:
+
+```bash
+cd my-app
+npm run dev
+```
+
+From there you can keep using the local CLI:
+
+```bash
+npx edgebase deploy
+npx edgebase typegen
+```
+
+## Related Packages
+
+- [`@edgebase-fun/cli`](https://www.npmjs.com/package/@edgebase-fun/cli)
+  The underlying CLI package used after project creation
+- [`@edgebase-fun/web`](https://www.npmjs.com/package/@edgebase-fun/web)
+  Browser SDK for your app code
+
+## License
+
+MIT

package/bin/create-edgebase.js

@@ -0,0 +1,125 @@
+#!/usr/bin/env node
+
+import { spawnSync } from 'node:child_process';
+import { createRequire } from 'node:module';
+import { dirname, join, resolve } from 'node:path';
+import process from 'node:process';
+
+const require = createRequire(import.meta.url);
+
+function printUsage() {
+  console.log(`Usage:
+  npm create edgebase@latest <project-dir>
+  npm create edgebase@latest <project-dir> -- --no-dev
+  npm create edgebase@latest <project-dir> -- --no-open
+
+What it does:
+  1. Scaffolds a new EdgeBase project
+  2. Installs local project dependencies
+  3. Starts the dev server unless you pass --no-dev
+`);
+}
+
+function detectPackageManager() {
+  const userAgent = process.env.npm_config_user_agent ?? '';
+
+  if (userAgent.startsWith('pnpm/')) {
+    return {
+      name: 'pnpm',
+      command: 'pnpm',
+      installArgs: ['install'],
+      runScriptArgs(scriptName, extraArgs = []) {
+        return ['run', scriptName, ...extraArgs];
+      },
+    };
+  }
+
+  if (userAgent.startsWith('yarn/')) {
+    return {
+      name: 'yarn',
+      command: 'yarn',
+      installArgs: ['install'],
+      runScriptArgs(scriptName, extraArgs = []) {
+        return ['run', scriptName, ...extraArgs];
+      },
+    };
+  }
+
+  if (userAgent.startsWith('bun/')) {
+    return {
+      name: 'bun',
+      command: 'bun',
+      installArgs: ['install'],
+      runScriptArgs(scriptName, extraArgs = []) {
+        return ['run', scriptName, ...extraArgs];
+      },
+    };
+  }
+
+  return {
+    name: 'npm',
+    command: 'npm',
+    installArgs: ['install'],
+    runScriptArgs(scriptName, extraArgs = []) {
+      return ['run', scriptName, ...(extraArgs.length > 0 ? ['--', ...extraArgs] : [])];
+    },
+  };
+}
+
+function runOrExit(command, args, options = {}) {
+  const result = spawnSync(command, args, {
+    stdio: 'inherit',
+    ...options,
+  });
+
+  if (result.error) {
+    throw result.error;
+  }
+
+  if (typeof result.status === 'number' && result.status !== 0) {
+    process.exit(result.status);
+  }
+}
+
+const rawArgs = process.argv.slice(2);
+if (rawArgs.includes('--help') || rawArgs.includes('-h')) {
+  printUsage();
+  process.exit(0);
+}
+
+const forwardedArgs = [...rawArgs];
+const wantsNoDev = forwardedArgs.includes('--no-dev');
+const wantsNoOpen = forwardedArgs.includes('--no-open');
+const scaffoldArgs = wantsNoDev ? forwardedArgs : [...forwardedArgs, '--no-dev'];
+const targetDirArg = forwardedArgs.find((arg) => !arg.startsWith('-')) ?? '.';
+const projectDir = resolve(process.cwd(), targetDirArg);
+const packageManager = detectPackageManager();
+const skipInstall = process.env.EDGEBASE_CREATE_SKIP_INSTALL === '1';
+const cliPackageJsonPath = require.resolve('@edgebase-fun/cli/package.json');
+const cliEntryPath = join(dirname(cliPackageJsonPath), 'dist', 'index.js');
+
+runOrExit(process.execPath, [cliEntryPath, 'init', ...scaffoldArgs], {
+  cwd: process.cwd(),
+  env: {
+    ...process.env,
+    EDGEBASE_BOOTSTRAP_WRAPPER: '1',
+  },
+});
+
+if (!skipInstall) {
+  console.log();
+  console.log(`Installing project dependencies with ${packageManager.name}...`);
+  runOrExit(packageManager.command, packageManager.installArgs, {
+    cwd: projectDir,
+    env: process.env,
+  });
+}
+
+if (!wantsNoDev) {
+  console.log();
+  console.log('Starting the EdgeBase dev server...');
+  runOrExit(packageManager.command, packageManager.runScriptArgs('dev', wantsNoOpen ? ['--no-open'] : []), {
+    cwd: projectDir,
+    env: process.env,
+  });
+}

package/llms.txt

@@ -0,0 +1,72 @@
+# create-edgebase
+
+Use this file as a quick-reference contract for AI coding assistants working with `create-edgebase`.
+
+## Package Boundary
+
+`create-edgebase` is the bootstrap package behind `npm create edgebase@latest`.
+
+It is not the long-lived runtime CLI package. After scaffolding, day-to-day commands come from the local `@edgebase-fun/cli` install inside the generated project.
+
+## Source Of Truth
+
+- Package README: https://github.com/edge-base/edgebase/blob/main/packages/create-edgebase/README.md
+- Quickstart: https://edgebase.fun/docs/getting-started/quickstart
+- CLI overview: https://edgebase.fun/docs/cli
+- CLI workflows: https://edgebase.fun/docs/cli/workflows
+
+## Canonical Examples
+
+### Create a new dedicated project
+
+```bash
+npm create edgebase@latest my-app
+```
+
+### Add EdgeBase inside an existing frontend project
+
+```bash
+cd your-frontend-project
+npm create edgebase@latest edgebase
+```
+
+### Scaffold without auto-starting dev
+
+```bash
+npm create edgebase@latest my-app -- --no-dev
+```
+
+### Scaffold without opening the browser
+
+```bash
+npm create edgebase@latest my-app -- --no-open
+```
+
+### Automation without install
+
+```bash
+EDGEBASE_CREATE_SKIP_INSTALL=1 npm create edgebase@latest my-app -- --no-dev
+```
+
+## Behavior Notes
+
+- scaffolds a project by delegating to `@edgebase-fun/cli init`
+- installs local dependencies unless `EDGEBASE_CREATE_SKIP_INSTALL=1`
+- starts `npm run dev` unless `--no-dev` is passed
+- forwards `--no-open` to the local development flow
+- merges EdgeBase entries into existing `package.json` and `.gitignore` files instead of replacing them wholesale
+
+## Common Mistakes
+
+- use `npm create edgebase@latest`, not `npm edgebase`
+- do not treat `create-edgebase` as the package you use for ongoing commands
+- if integrating into an existing repo, prefer a dedicated subdirectory like `edgebase/`
+- use `-- --no-dev` after the project name because flags after `npm create` are forwarded through npm
+
+## Quick Reference
+
+```text
+npm create edgebase@latest my-app             -> scaffold, install, start dev
+npm create edgebase@latest my-app -- --no-dev -> scaffold, install, do not start dev
+npm create edgebase@latest my-app -- --no-open -> scaffold, install, start dev without opening browser
+```

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "create-edgebase",
+  "version": "0.1.0",
+  "description": "Bootstrap a new EdgeBase project",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/edge-base/edgebase.git",
+    "directory": "packages/create-edgebase"
+  },
+  "homepage": "https://edgebase.fun",
+  "bugs": "https://github.com/edge-base/edgebase/issues",
+  "keywords": [
+    "edgebase",
+    "create-edgebase",
+    "scaffold",
+    "cli"
+  ],
+  "type": "module",
+  "bin": {
+    "create-edgebase": "./bin/create-edgebase.js"
+  },
+  "files": [
+    "bin",
+    "llms.txt"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "dependencies": {
+    "@edgebase-fun/cli": "0.1.0"
+  }
+}