@edge-base/cli 0.1.1

package/dist/templates/plugin/server/src/index.ts.tmpl

@@ -0,0 +1,59 @@
+/**
+ * {{PLUGIN_NAME}} — EdgeBase Plugin
+ *
+ * Define your plugin's tables, functions, and hooks below.
+ *
+ * Usage in edgebase.config.ts:
+ * ```typescript
+ * import { {{PLUGIN_NAME_CAMEL}}Plugin } from '{{PLUGIN_NAME}}';
+ * export default defineConfig({
+ *   plugins: [ {{PLUGIN_NAME_CAMEL}}Plugin({ apiKey: process.env.MY_API_KEY! }) ],
+ * });
+ * ```
+ */
+import { definePlugin } from '@edge-base/plugin-core';
+
+interface {{PLUGIN_NAME_PASCAL}}Config {
+  apiKey: string;
+}
+
+export const {{PLUGIN_NAME_CAMEL}}Plugin = definePlugin<{{PLUGIN_NAME_PASCAL}}Config>({
+  name: '{{PLUGIN_NAME}}',
+  version: '0.1.0',
+  manifest: {
+    description: '{{PLUGIN_NAME}} functionality',
+    configTemplate: {
+      apiKey: 'CHANGE_ME',
+    },
+  },
+
+  tables: {
+    // Example table — rename to match your domain
+    // items: {
+    //   schema: {
+    //     name: { type: 'string', required: true },
+    //     status: { type: 'string', default: 'active' },
+    //   },
+    //   access: {
+    //     read: (auth) => auth !== null,
+    //     insert: (auth) => auth !== null,
+    //   },
+    //   handlers: {
+    //     hooks: {
+    //       beforeInsert: async (_auth, data) => ({ ...data, source: '{{PLUGIN_NAME}}' }),
+    //     },
+    //   },
+    // },
+  },
+
+  functions: {
+    // Example function — rename to match your use case
+    // 'hello': {
+    //   trigger: { type: 'http', method: 'GET', path: '/{{PLUGIN_NAME}}/hello' },
+    //   handler: async (ctx) => {
+    //     const key = ctx.pluginConfig.apiKey;  // typed via {{PLUGIN_NAME_PASCAL}}Config
+    //     return Response.json({ message: 'Hello from {{PLUGIN_NAME}}!' });
+    //   },
+    // },
+  },
+});

package/dist/templates/plugin/server/tsconfig.json.tmpl

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "declaration": true,
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true
+  },
+  "include": ["src"]
+}

package/llms.txt

@@ -0,0 +1,94 @@
+# EdgeBase CLI
+
+Use this file as a quick-reference contract for AI coding assistants working with `@edge-base/cli`.
+
+## Package Boundary
+
+Use `@edge-base/cli` to scaffold, develop, deploy, inspect, and operate EdgeBase projects.
+
+Do not assume a public unscoped `edgebase` npm package exists. For new projects, use `npm create edge-base@latest`. Inside generated projects, use the local `edgebase` binary through `npx edgebase` or `npm run ...`.
+
+## Source Of Truth
+
+- Package README: https://github.com/edge-base/edgebase/blob/main/packages/cli/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
+- CLI reference: https://edgebase.fun/docs/cli/reference
+
+If examples, docs, and assumptions disagree, prefer the current CLI behavior and official docs over guessed flags.
+
+## Canonical Examples
+
+### Create a new project
+
+```bash
+npm create edge-base@latest my-app
+```
+
+### Start local development in a generated project
+
+```bash
+cd my-app
+npm run dev
+```
+
+### Run the local CLI directly
+
+```bash
+cd my-app
+npx edgebase dev
+```
+
+### Deploy
+
+```bash
+cp .env.release.example .env.release
+npx edgebase deploy
+```
+
+### Automation-friendly mode
+
+```bash
+edgebase --json --non-interactive describe
+edgebase --json --non-interactive deploy
+```
+
+## Command Areas
+
+- Project lifecycle: `init`, `dev`, `deploy`, `destroy`, `logs`, `upgrade`
+- Data workflow: `migration`, `migrate`, `seed`, `backup`, `export`, `typegen`, `neon`
+- Security and admin: `secret`, `keys`, `admin`
+- Plugins and tooling: `plugins`, `create-plugin`, `docker`, `webhook-test`, `completion`, `describe`, `telemetry`, `realtime`
+
+## Common Mistakes
+
+- use `npm create edge-base@latest <dir>` for bootstrapping, not `npm edgebase`
+- inside a generated project, `npx edgebase ...` works because the CLI is installed locally
+- outside a generated project, do not assume `npx edgebase ...` will work unless the CLI is globally installed
+- for agents, CI, or editors, prefer `--json --non-interactive`
+- if you need to inspect the live command surface, use `edgebase describe` instead of guessing flags
+- remote commands often require `EDGEBASE_URL`
+- Service Key protected flows require `EDGEBASE_SERVICE_KEY`
+- destructive commands like `destroy` and `backup restore` should be preceded by dry runs or explicit confirmation
+
+## Quick Reference
+
+```text
+edgebase dev                                 -> run local development
+edgebase deploy                              -> deploy project resources and worker
+edgebase destroy --dry-run                   -> inspect cleanup plan
+edgebase typegen                             -> generate schema types
+edgebase migration create <name>             -> generate migration snippet
+edgebase backup create --url ... --service-key ... -> create portable backup
+edgebase --json describe                     -> inspect command tree
+edgebase --json describe --command "deploy"  -> inspect one command
+```
+
+## Environment Variables
+
+- `EDGEBASE_URL`
+- `EDGEBASE_SERVICE_KEY`
+- `CLOUDFLARE_API_TOKEN`
+- `CLOUDFLARE_ACCOUNT_ID`
+- `NEON_API_KEY`

package/package.json

@@ -0,0 +1,60 @@
+{
+    "name": "@edge-base/cli",
+    "version": "0.1.1",
+    "description": "CLI for EdgeBase — create, develop, and deploy EdgeBase projects",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/edge-base/edgebase.git",
+        "directory": "packages/cli"
+    },
+    "homepage": "https://edgebase.fun",
+    "bugs": "https://github.com/edge-base/edgebase/issues",
+    "keywords": [
+        "edgebase",
+        "cli",
+        "baas",
+        "backend",
+        "cloudflare-workers"
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "type": "module",
+    "bin": {
+        "edgebase": "./dist/index.js"
+    },
+    "main": "./dist/index.js",
+    "files": [
+        "dist",
+        "llms.txt"
+    ],
+    "scripts": {
+        "build": "tsc && node ./scripts/copy-assets.mjs",
+        "lint": "eslint src/ --max-warnings 0",
+        "test": "vitest run",
+        "dev": "tsc --watch",
+        "prepack": "pnpm run build"
+    },
+    "engines": {
+        "node": ">=20.19.0"
+    },
+    "dependencies": {
+        "@edge-base/server": "workspace:*",
+        "@edge-base/shared": "workspace:*",
+        "chalk": "^5.4.0",
+        "commander": "^13.1.0",
+        "esbuild": "^0.27.3",
+        "jose": "^6.0.0",
+        "ora": "^9.3.0",
+        "pg": "^8.16.3",
+        "tsx": "^4.20.6",
+        "ts-morph": "^27.0.2",
+        "wrangler": "^4.70.0"
+    },
+    "devDependencies": {
+        "@types/node": "^25.2.3",
+        "typescript": "^5.7.0",
+        "vitest": "^3.0.0"
+    }
+}