CLI
The edgebase CLI handles development, deployment, type generation, backups, and admin operations.
Its Service Key workflows align with the same credentials used by all Admin SDKs.
Installation
npm install -g @edgebase/cli
# or use npx
npx edgebase <command>
Key Commands
| Command | Description |
|---|---|
edgebase init | Create a new project, start dev server, and open admin dashboard |
edgebase dev | Start local dev server with hot-reload (dashboard opens automatically, --no-open to disable) |
edgebase deploy | Auto-login to Cloudflare + bundle and deploy (secrets auto-uploaded) |
edgebase typegen | Generate TypeScript types from your schema |
edgebase backup create | Full backup (DO + D1 + R2 + secrets) |
edgebase backup restore | Restore from backup |
edgebase export --table | Export table data as JSON |
edgebase keys rotate | Rotate the root Service Key secret immediately |
edgebase admin | Admin account management and password reset |
edgebase create-plugin | Scaffold a new plugin project with server + client boilerplate |
edgebase webhook-test | Send test webhook events to local dev server |
Development Workflow
# 1. Create project (auto-starts dev server + opens admin dashboard)
npx edgebase init my-app
# 2. Deploy to production
cd my-app
npx edgebase deploy
The dev command starts a local server with:
- Config hot-reload — schema and rule changes apply instantly
- Function hot-reload — App Functions rebuild on file save
- Schema editor — visual schema editor sidecar at
/admin
Next Steps
| Page | Description |
|---|---|
| CLI Reference | Complete command reference with all flags and options |