create-edgebase is the package behind:

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:

npm create edgebase@latest my-app

Documentation Map

• Quickstart First-run setup for a new EdgeBase project
• CLI Overview What the local CLI covers once the project exists
• CLI Workflows Common flows after scaffolding

For AI Coding Assistants

This package ships with an llms.txt file for AI-assisted scaffolding.

For the higher-level SDK and trust-boundary rules, start with the official Use EdgeBase With AI guide and then read this package's llms.txt for scaffold-specific details.

You can find it:

• after install: node_modules/create-edgebase/llms.txt
• in the repository: llms.txt

Use it when you want an agent to:

• choose the correct bootstrap command
• understand the --no-dev and --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

npm create edgebase@latest my-app

Add EdgeBase inside an existing frontend project

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

npm create edgebase@latest my-app -- --no-dev

Open the browser when dev starts

npm create edgebase@latest my-app -- --open

Skip dependency install in automation

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
• AGENTS.md and .github/copilot-instructions.md with EdgeBase-specific AI guidance
• 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. If the target directory already contains AGENTS.md or .github/copilot-instructions.md, the scaffold preserves existing content and refreshes the managed EdgeBase guidance block.

What Happens Next

After scaffolding, the usual next step is:

cd my-app
npm run dev

From there you can keep using the local CLI:

npx edgebase deploy
npx edgebase typegen

Related Packages

• @edge-base/cli The underlying CLI package used after project creation
• @edge-base/web Browser SDK for your app code

License

MIT