@quickback-dev/cli 0.66.1 → 0.66.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -4
- package/dist/commands/build.d.ts +51 -0
- package/dist/commands/build.d.ts.map +1 -0
- package/dist/commands/build.js +793 -0
- package/dist/commands/build.js.map +1 -0
- package/dist/commands/build.test.d.ts +2 -0
- package/dist/commands/build.test.d.ts.map +1 -0
- package/dist/commands/build.test.js +150 -0
- package/dist/commands/build.test.js.map +1 -0
- package/dist/commands/check.d.ts +2 -2
- package/dist/commands/check.js +4 -4
- package/dist/commands/check.js.map +1 -1
- package/dist/commands/create.d.ts +1 -1
- package/dist/commands/create.js +7 -7
- package/dist/commands/create.js.map +1 -1
- package/dist/commands/deploy.d.ts +6 -6
- package/dist/commands/deploy.js +23 -23
- package/dist/commands/deploy.js.map +1 -1
- package/dist/commands/example.js +1 -1
- package/dist/commands/example.js.map +1 -1
- package/dist/commands/mcp.js +1 -1
- package/dist/commands/mcp.js.map +1 -1
- package/dist/commands/migrate.d.ts +1 -1
- package/dist/commands/migrate.js +3 -3
- package/dist/commands/migrate.js.map +1 -1
- package/dist/commands/migrations.js +2 -2
- package/dist/commands/migrations.js.map +1 -1
- package/dist/commands/push.js +1 -1
- package/dist/commands/push.js.map +1 -1
- package/dist/commands/start.js +1 -1
- package/dist/commands/start.js.map +1 -1
- package/dist/cursor/quickback.mdc +1 -1
- package/dist/index.js +18 -15
- package/dist/index.js.map +1 -1
- package/dist/lib/auth.js +1 -1
- package/dist/lib/auth.js.map +1 -1
- package/dist/lib/compiler-floor.d.ts +1 -1
- package/dist/lib/compiler-floor.js +1 -1
- package/dist/lib/file-loader.js +2 -2
- package/dist/lib/file-loader.js.map +1 -1
- package/dist/lib/file-writer.d.ts +2 -0
- package/dist/lib/file-writer.d.ts.map +1 -1
- package/dist/lib/file-writer.js +16 -0
- package/dist/lib/file-writer.js.map +1 -1
- package/dist/lib/file-writer.test.js +16 -0
- package/dist/lib/file-writer.test.js.map +1 -1
- package/dist/lib/migrations/file-envelopes.js +3 -3
- package/dist/lib/migrations/file-envelopes.js.map +1 -1
- package/dist/lib/prepare-output.test.js +1 -1
- package/dist/lib/prepare-output.test.js.map +1 -1
- package/dist/lib/schema-sync/index.js +1 -1
- package/dist/lib/schema-sync/index.test.js +1 -1
- package/dist/lib/schema-sync/index.test.js.map +1 -1
- package/dist/skill/SKILL.md +6 -6
- package/dist/skill/docs/api/crud.md +7 -0
- package/dist/skill/docs/api/index.md +1 -1
- package/dist/skill/docs/api/openapi.md +1 -1
- package/dist/skill/docs/changelog/index.md +19 -1
- package/dist/skill/docs/configure/agents.md +1 -1
- package/dist/skill/docs/configure/index.md +8 -3
- package/dist/skill/docs/configure/providers.md +1 -0
- package/dist/skill/docs/configure/variables.md +3 -3
- package/dist/skill/docs/define/access.md +7 -0
- package/dist/skill/docs/define/actions/defining.md +35 -7
- package/dist/skill/docs/define/actions/record-and-standalone.md +7 -4
- package/dist/skill/docs/define/actions/scoped-db.md +46 -16
- package/dist/skill/docs/define/areas.md +1 -1
- package/dist/skill/docs/define/diagnostics.md +1 -0
- package/dist/skill/docs/define/encryption.md +1 -1
- package/dist/skill/docs/define/feature.md +14 -7
- package/dist/skill/docs/define/guards.md +27 -3
- package/dist/skill/docs/define/schema.md +24 -14
- package/dist/skill/docs/define/security.md +1 -1
- package/dist/skill/docs/define/transitions.md +35 -4
- package/dist/skill/docs/define/views.md +33 -0
- package/dist/skill/docs/index.md +2 -2
- package/dist/skill/docs/platform/auth/api-keys.md +1 -1
- package/dist/skill/docs/platform/auth/using-auth.md +37 -0
- package/dist/skill/docs/platform/database/d1.md +2 -2
- package/dist/skill/docs/platform/database/neon.md +4 -4
- package/dist/skill/docs/platform/email/index.md +1 -1
- package/dist/skill/docs/platform/queues/handlers.md +1 -1
- package/dist/skill/docs/platform/queues/using-queues.md +1 -1
- package/dist/skill/docs/platform/schedules/index.md +1 -1
- package/dist/skill/docs/platform/storage/index.md +3 -3
- package/dist/skill/docs/platform/storage/r2.md +87 -37
- package/dist/skill/docs/platform/storage/using-r2.md +99 -19
- package/dist/skill/docs/platform/webhooks/inbound.md +40 -0
- package/dist/skill/docs/start/deploy-browser.md +39 -44
- package/dist/skill/docs/start/deploy-owner-access.md +28 -19
- package/dist/skill/docs/start/deploy.md +2 -2
- package/dist/skill/docs/start/first-api.md +1 -1
- package/dist/skill/docs/start/hand-crafted.md +3 -3
- package/dist/skill/docs/start/index.md +3 -3
- package/dist/skill/docs/start/quickstart.md +3 -3
- package/dist/skill/docs/start/template-blog.md +2 -2
- package/dist/skill/docs/start/template-cloudflare.md +2 -2
- package/dist/skill/docs/start/template-empty.md +1 -1
- package/dist/skill/docs/start/templates.md +1 -1
- package/dist/skill/docs/tooling/claude-skill.md +1 -1
- package/dist/skill/docs/tooling/cli.md +20 -15
- package/dist/skill/docs/tooling/cloud-compiler/authentication.md +1 -1
- package/dist/skill/docs/tooling/cloud-compiler/endpoints.md +5 -3
- package/dist/skill/docs/tooling/cloud-compiler/index.md +1 -1
- package/dist/skill/docs/tooling/cloud-compiler/local-compiler.md +2 -2
- package/dist/skill/docs/tooling/cloud-compiler/troubleshooting.md +47 -2
- package/dist/skill/docs/tooling/output.md +23 -2
- package/dist/skill/docs/tooling/troubleshooting.md +1 -1
- package/dist/skill/docs/ui/account/environment-variables.md +2 -2
- package/dist/skill/docs/ui/account/features/admin.md +1 -1
- package/dist/skill/docs/ui/account/features/avatars.md +24 -8
- package/dist/skill/docs/ui/account/features/index.md +9 -5
- package/dist/skill/docs/ui/account/features/organizations.md +3 -2
- package/dist/skill/docs/ui/account/index.md +3 -1
- package/dist/skill/docs/ui/account/with-quickback.md +1 -1
- package/dist/skill/docs/ui/admin/actions.md +97 -3
- package/dist/skill/docs/ui/admin/components.md +4 -6
- package/dist/skill/docs/ui/admin/connecting.md +15 -3
- package/dist/skill/docs/ui/admin/index.md +71 -6
- package/dist/skill/docs/ui/admin/inline-editing.md +38 -4
- package/dist/skill/docs/ui/admin/record-layouts.md +22 -21
- package/dist/skill/docs/ui/admin/schema-format.md +39 -2
- package/dist/skill/docs/ui/admin/schema-registry.md +107 -7
- package/dist/skill/docs/ui/admin/security.md +19 -4
- package/dist/skill/docs/ui/admin/table-views.md +59 -12
- package/package.json +1 -1
- package/src/cursor/quickback.mdc +1 -1
- package/src/skill/SKILL.md +6 -6
- package/src/skill/docs/api/crud.md +7 -0
- package/src/skill/docs/api/index.md +1 -1
- package/src/skill/docs/api/openapi.md +1 -1
- package/src/skill/docs/changelog/index.md +19 -1
- package/src/skill/docs/configure/agents.md +1 -1
- package/src/skill/docs/configure/index.md +8 -3
- package/src/skill/docs/configure/providers.md +1 -0
- package/src/skill/docs/configure/variables.md +3 -3
- package/src/skill/docs/define/access.md +7 -0
- package/src/skill/docs/define/actions/defining.md +35 -7
- package/src/skill/docs/define/actions/record-and-standalone.md +7 -4
- package/src/skill/docs/define/actions/scoped-db.md +46 -16
- package/src/skill/docs/define/areas.md +1 -1
- package/src/skill/docs/define/diagnostics.md +1 -0
- package/src/skill/docs/define/encryption.md +1 -1
- package/src/skill/docs/define/feature.md +14 -7
- package/src/skill/docs/define/guards.md +27 -3
- package/src/skill/docs/define/schema.md +24 -14
- package/src/skill/docs/define/security.md +1 -1
- package/src/skill/docs/define/transitions.md +35 -4
- package/src/skill/docs/define/views.md +33 -0
- package/src/skill/docs/index.md +2 -2
- package/src/skill/docs/platform/auth/api-keys.md +1 -1
- package/src/skill/docs/platform/auth/using-auth.md +37 -0
- package/src/skill/docs/platform/database/d1.md +2 -2
- package/src/skill/docs/platform/database/neon.md +4 -4
- package/src/skill/docs/platform/email/index.md +1 -1
- package/src/skill/docs/platform/queues/handlers.md +1 -1
- package/src/skill/docs/platform/queues/using-queues.md +1 -1
- package/src/skill/docs/platform/schedules/index.md +1 -1
- package/src/skill/docs/platform/storage/index.md +3 -3
- package/src/skill/docs/platform/storage/r2.md +87 -37
- package/src/skill/docs/platform/storage/using-r2.md +99 -19
- package/src/skill/docs/platform/webhooks/inbound.md +40 -0
- package/src/skill/docs/start/deploy-browser.md +39 -44
- package/src/skill/docs/start/deploy-owner-access.md +28 -19
- package/src/skill/docs/start/deploy.md +2 -2
- package/src/skill/docs/start/first-api.md +1 -1
- package/src/skill/docs/start/hand-crafted.md +3 -3
- package/src/skill/docs/start/index.md +3 -3
- package/src/skill/docs/start/quickstart.md +3 -3
- package/src/skill/docs/start/template-blog.md +2 -2
- package/src/skill/docs/start/template-cloudflare.md +2 -2
- package/src/skill/docs/start/template-empty.md +1 -1
- package/src/skill/docs/start/templates.md +1 -1
- package/src/skill/docs/tooling/claude-skill.md +1 -1
- package/src/skill/docs/tooling/cli.md +20 -15
- package/src/skill/docs/tooling/cloud-compiler/authentication.md +1 -1
- package/src/skill/docs/tooling/cloud-compiler/endpoints.md +5 -3
- package/src/skill/docs/tooling/cloud-compiler/index.md +1 -1
- package/src/skill/docs/tooling/cloud-compiler/local-compiler.md +2 -2
- package/src/skill/docs/tooling/cloud-compiler/troubleshooting.md +47 -2
- package/src/skill/docs/tooling/output.md +23 -2
- package/src/skill/docs/tooling/troubleshooting.md +1 -1
- package/src/skill/docs/ui/account/environment-variables.md +2 -2
- package/src/skill/docs/ui/account/features/admin.md +1 -1
- package/src/skill/docs/ui/account/features/avatars.md +24 -8
- package/src/skill/docs/ui/account/features/index.md +9 -5
- package/src/skill/docs/ui/account/features/organizations.md +3 -2
- package/src/skill/docs/ui/account/index.md +3 -1
- package/src/skill/docs/ui/account/with-quickback.md +1 -1
- package/src/skill/docs/ui/admin/actions.md +97 -3
- package/src/skill/docs/ui/admin/components.md +4 -6
- package/src/skill/docs/ui/admin/connecting.md +15 -3
- package/src/skill/docs/ui/admin/index.md +71 -6
- package/src/skill/docs/ui/admin/inline-editing.md +38 -4
- package/src/skill/docs/ui/admin/record-layouts.md +22 -21
- package/src/skill/docs/ui/admin/schema-format.md +39 -2
- package/src/skill/docs/ui/admin/schema-registry.md +107 -7
- package/src/skill/docs/ui/admin/security.md +19 -4
- package/src/skill/docs/ui/admin/table-views.md +59 -12
|
@@ -1,23 +1,29 @@
|
|
|
1
1
|
# Owner access after a browser deploy
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
first deploy seeds your app's first administrator
|
|
5
|
-
a first organization they own, and a password.
|
|
6
|
-
**click-to-reveal password**,
|
|
3
|
+
After you build in **Generated Backend** and deploy from **Cloudflare
|
|
4
|
+
Infrastructure**, the very first deploy seeds your app's first administrator
|
|
5
|
+
(`user.role === "sysadmin"`), a first organization they own, and a password.
|
|
6
|
+
Cloudflare Infrastructure shows the **email**, a **click-to-reveal password**,
|
|
7
|
+
and a normal link to your app's Account login:
|
|
7
8
|
|
|
8
9
|
```
|
|
9
10
|
https://<your-app>.<subdomain>.workers.dev/account/login
|
|
10
11
|
```
|
|
11
12
|
|
|
12
13
|
Sign in with that email and password. That's the whole setup. After sign-in,
|
|
13
|
-
`/cms/` opens
|
|
14
|
-
|
|
14
|
+
`/cms/` opens on the **organization membership** the deploy also seeded — you
|
|
15
|
+
are `owner` of the first org. That is the role hierarchy (`owner` / `admin` /
|
|
16
|
+
`member`), not `user.role`. Start sets `cms.access: "member"` so the CMS uses
|
|
17
|
+
that seat. `user.role === "sysadmin"` is the platform data-plane tier (one
|
|
18
|
+
above `appmanager`); the CMS only falls back to it when you belong to no
|
|
19
|
+
organization.
|
|
15
20
|
|
|
16
21
|
## What you get
|
|
17
22
|
|
|
18
23
|
- **Shown once.** The plaintext password is returned to Start on the deploy
|
|
19
|
-
that created the admin
|
|
20
|
-
|
|
24
|
+
that created the admin. Quickback stores the hash in your app's auth
|
|
25
|
+
database, never the password. Copy it when you see it — a later refresh
|
|
26
|
+
does not show it again.
|
|
21
27
|
- **A first organization.** The deploy also inserts an organization named after
|
|
22
28
|
your Worker and seats the admin as `owner`, so org-scoped tables and the CMS
|
|
23
29
|
tenant picker have somewhere to land. A routine redeploy does not create a
|
|
@@ -33,8 +39,12 @@ one above `appmanager`.
|
|
|
33
39
|
`<a href="…/account/login">`. It does not carry a token. Anyone can open
|
|
34
40
|
the page; only the password signs you in.
|
|
35
41
|
|
|
36
|
-
The
|
|
37
|
-
|
|
42
|
+
The email is the **verified address on your Quickback account** — the same
|
|
43
|
+
one you used to sign in to Start. It is written once, when the admin is
|
|
44
|
+
created. The broker never changes the email afterwards.
|
|
45
|
+
|
|
46
|
+
Type it exactly as shown next to the password. Apps seeded before this keep
|
|
47
|
+
whatever address they were given (`owner@<app>.invalid` on older deploys).
|
|
38
48
|
|
|
39
49
|
## Signing up yourself doesn't make you an admin
|
|
40
50
|
|
|
@@ -45,23 +55,22 @@ admin is the only path to the first administrator.
|
|
|
45
55
|
No confirmation email is sent, either — apps built from Start default to email
|
|
46
56
|
and password with verification off, because a `workers.dev` deploy has no
|
|
47
57
|
verified sending domain. If you're waiting on a signup email, nothing is
|
|
48
|
-
coming; use the credentials
|
|
58
|
+
coming; use the credentials in Cloudflare Infrastructure.
|
|
49
59
|
|
|
50
60
|
**Quickback is not your app's identity provider.** The password reveal is a
|
|
51
61
|
bootstrap window, not a login method: once you've signed in (or reset), your
|
|
52
62
|
app has no runtime dependency on Quickback or the deploy broker for
|
|
53
63
|
authentication.
|
|
54
64
|
|
|
55
|
-
## Lost access
|
|
65
|
+
## Lost access
|
|
56
66
|
|
|
57
|
-
Deployed apps on `workers.dev` can't send password-reset email
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
67
|
+
Deployed apps on `workers.dev` can't send password-reset email until the
|
|
68
|
+
app has outbound email (a custom domain + a sending provider). Copy the
|
|
69
|
+
password when Cloudflare Infrastructure first shows it. Once email works,
|
|
70
|
+
Better Auth's own forgot-password flow can reach that inbox, because it is
|
|
71
|
+
a real, verified address.
|
|
62
72
|
|
|
63
|
-
A routine redeploy does **not** re-surface credentials.
|
|
64
|
-
reset does.
|
|
73
|
+
A routine redeploy does **not** re-surface credentials.
|
|
65
74
|
|
|
66
75
|
## For CLI deploys
|
|
67
76
|
|
|
@@ -13,7 +13,7 @@ cd my-app && quickback deploy
|
|
|
13
13
|
## What it does
|
|
14
14
|
|
|
15
15
|
1. **Preflight** — verifies `wrangler` is runnable (via `npx`) and authenticated with Cloudflare (`wrangler whoami`). Log in with `npx wrangler login` or set `CLOUDFLARE_API_TOKEN`.
|
|
16
|
-
2. **Compiles first if needed** — if the project has never compiled (no `wrangler.toml`), it runs the same flow as `quickback
|
|
16
|
+
2. **Compiles first if needed** — if the project has never compiled (no `wrangler.toml`), it runs the same flow as `quickback build` before planning anything.
|
|
17
17
|
3. **Plans from wrangler.toml** — reads the generated `wrangler.toml` and finds every resource whose id is still a placeholder:
|
|
18
18
|
- **D1 databases** — auth, features, files, webhooks, and audit databases (whichever your project's features pull in; split-database projects get one entry each)
|
|
19
19
|
- **KV namespace** — the `KV` binding used for rate limiting and session overflow
|
|
@@ -53,7 +53,7 @@ Run it again any time. When every id is real, there's nothing to create — the
|
|
|
53
53
|
| `--dry-run` | Print the provisioning plan (what would be created vs. what's already set) and exit. Creates nothing. |
|
|
54
54
|
| `--skip-deploy` | Provision resources + sync ids + recompile, but skip migrations and the deploy itself. |
|
|
55
55
|
| `--force` | Overwrite a config id that differs from what Cloudflare reports. Without it, a mismatch prints both values and aborts — never silently overwritten. |
|
|
56
|
-
| `--verbose` | Detailed remote compile failure output (same as `quickback
|
|
56
|
+
| `--verbose` | Detailed remote compile failure output (same as `quickback build --verbose`). |
|
|
57
57
|
|
|
58
58
|
```bash
|
|
59
59
|
# See the plan without touching your account
|
|
@@ -118,7 +118,7 @@ export default defineTable(candidates, {
|
|
|
118
118
|
|
|
119
119
|
```bash
|
|
120
120
|
quickback login
|
|
121
|
-
quickback
|
|
121
|
+
quickback build
|
|
122
122
|
```
|
|
123
123
|
|
|
124
124
|
The compiler generates a complete `src/` directory with route handlers, middleware, database schemas, and migrations.
|
|
@@ -191,7 +191,7 @@ To add a new feature, create a new directory under `quickback/features/` and rec
|
|
|
191
191
|
```bash
|
|
192
192
|
mkdir quickback/features/jobs
|
|
193
193
|
# Create jobs/jobs.ts with defineTable(...)
|
|
194
|
-
quickback
|
|
194
|
+
quickback build
|
|
195
195
|
```
|
|
196
196
|
|
|
197
197
|
The compiler detects all features automatically — no registration needed.
|
|
@@ -201,7 +201,7 @@ The compiler detects all features automatically — no registration needed.
|
|
|
201
201
|
After any change to your definitions, recompile to regenerate the output:
|
|
202
202
|
|
|
203
203
|
```bash
|
|
204
|
-
quickback
|
|
204
|
+
quickback build
|
|
205
205
|
```
|
|
206
206
|
|
|
207
207
|
The compiler regenerates the entire `src/` directory. Your definitions in `quickback/` are the source of truth — never edit the generated files directly.
|
|
@@ -6,11 +6,11 @@ Cloudflare Workers, backed by D1 or Neon.
|
|
|
6
6
|
|
|
7
7
|
```
|
|
8
8
|
feature() ─┐
|
|
9
|
-
├─► quickback
|
|
9
|
+
├─► quickback build ─► Hono API on Cloudflare
|
|
10
10
|
defineAction() ─┘ (D1 or Neon)
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
When you run `quickback
|
|
13
|
+
When you run `quickback build`, it:
|
|
14
14
|
|
|
15
15
|
1. **Reads your definitions** — every `feature()`, `defineAction()`, and `defineConfig()` in your project
|
|
16
16
|
2. **Validates security** — firewall, access, guards, and masking are checked for consistency
|
|
@@ -84,6 +84,6 @@ The rest of this page is the vocabulary the other pages assume.
|
|
|
84
84
|
|
|
85
85
|
| Term | Definition |
|
|
86
86
|
|------|-----------|
|
|
87
|
-
| **Compiler** | The generator behind `quickback
|
|
87
|
+
| **Compiler** | The generator behind `quickback build`. Use the zero-setup hosted service at `compiler.quickback.dev`, or run the same compiler image locally when source policy or build availability calls for it. |
|
|
88
88
|
| **Stack** | The runtime infrastructure (Cloudflare Workers, D1, KV, R2, Better Auth) where your compiled API runs. |
|
|
89
89
|
| **Template** | A pre-configured project starter (`cloudflare`, `bun`, `turso`) created by `quickback create`. |
|
|
@@ -9,7 +9,7 @@ mkdir my-app && cd my-app
|
|
|
9
9
|
npx @quickback-dev/cli start
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
`quickback start` is interactive — it asks for a template and project name, scaffolds the project on disk, and only prompts for an account just before compiling. If you cancel at the login prompt the scaffold stays put; finish later with `quickback login && quickback
|
|
12
|
+
`quickback start` is interactive — it asks for a template and project name, scaffolds the project on disk, and only prompts for an account just before compiling. If you cancel at the login prompt the scaffold stays put; finish later with `quickback login && quickback build`.
|
|
13
13
|
|
|
14
14
|
Already know what you want? Pass the template (and optionally a name) to skip the prompts:
|
|
15
15
|
|
|
@@ -141,7 +141,7 @@ See [feature() — the canonical form](/define/feature) and [Schema: Drizzle int
|
|
|
141
141
|
```bash
|
|
142
142
|
# Compile your definitions — prompts you to sign in or sign up
|
|
143
143
|
# if you haven't already (no separate `quickback login` step needed)
|
|
144
|
-
quickback
|
|
144
|
+
quickback build
|
|
145
145
|
|
|
146
146
|
# Run locally
|
|
147
147
|
npm run dev
|
|
@@ -173,7 +173,7 @@ Quickback generates these endpoints from the example above:
|
|
|
173
173
|
|
|
174
174
|
## Test Your API
|
|
175
175
|
|
|
176
|
-
After `quickback
|
|
176
|
+
After `quickback build` and `npm run dev`, your API is running locally. Open a second terminal and try these requests:
|
|
177
177
|
|
|
178
178
|
```bash
|
|
179
179
|
# 1. Create a user account
|
|
@@ -171,7 +171,7 @@ quickback login
|
|
|
171
171
|
### 3. Compile Your Definitions
|
|
172
172
|
|
|
173
173
|
```bash
|
|
174
|
-
quickback
|
|
174
|
+
quickback build
|
|
175
175
|
```
|
|
176
176
|
|
|
177
177
|
### 4. Create D1 Databases
|
|
@@ -296,7 +296,7 @@ export default defineTable(pages, {
|
|
|
296
296
|
Then recompile:
|
|
297
297
|
|
|
298
298
|
```bash
|
|
299
|
-
quickback
|
|
299
|
+
quickback build
|
|
300
300
|
```
|
|
301
301
|
|
|
302
302
|
## Deploying to Production
|
|
@@ -28,7 +28,7 @@ my-app/
|
|
|
28
28
|
├── quickback/
|
|
29
29
|
│ ├── quickback.config.ts # Compiler configuration
|
|
30
30
|
│ └── features/ # (empty — add your own)
|
|
31
|
-
├── src/ # Compiled output (generated by `quickback
|
|
31
|
+
├── src/ # Compiled output (generated by `quickback build`)
|
|
32
32
|
├── package.json
|
|
33
33
|
├── tsconfig.json
|
|
34
34
|
├── wrangler.toml
|
|
@@ -117,7 +117,7 @@ npm install
|
|
|
117
117
|
### 2. Compile Your Definitions
|
|
118
118
|
|
|
119
119
|
```bash
|
|
120
|
-
quickback
|
|
120
|
+
quickback build
|
|
121
121
|
```
|
|
122
122
|
|
|
123
123
|
This prompts for an account on the first run (sign in or create one in the browser), then generates the full `src/` directory, migrations, and configuration files. Subsequent compiles re-use the stored session.
|
|
@@ -106,7 +106,7 @@ For convenience, templates have short aliases:
|
|
|
106
106
|
|
|
107
107
|
```bash
|
|
108
108
|
cd my-app
|
|
109
|
-
quickback
|
|
109
|
+
quickback build # prompts for login on first run; reuses session after
|
|
110
110
|
npm run dev
|
|
111
111
|
```
|
|
112
112
|
|
|
@@ -263,7 +263,7 @@ Make sure the skill file exists and Claude Code is restarted. You can also invok
|
|
|
263
263
|
|
|
264
264
|
### Generated code has errors
|
|
265
265
|
|
|
266
|
-
Run `quickback
|
|
266
|
+
Run `quickback build` to validate. Share the error messages with Claude for fixes.
|
|
267
267
|
|
|
268
268
|
## Cursor IDE Rules
|
|
269
269
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# CLI Reference
|
|
2
2
|
|
|
3
|
-
The Quickback CLI is the fastest way to create,
|
|
3
|
+
The Quickback CLI is the fastest way to create, build, and manage your backend projects.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -25,7 +25,7 @@ Interactive onboarding designed for new users. No flags required.
|
|
|
25
25
|
- Prompts for a template (`cloudflare`, `todos`, `blog`, `empty`)
|
|
26
26
|
- Prompts for a project name (defaults to the current directory's name if empty)
|
|
27
27
|
- Auto-detects whether to scaffold in-place or create a `./<name>/` subdirectory
|
|
28
|
-
- Defers login until just before the
|
|
28
|
+
- Defers login until just before the build step — cancel at the auth prompt and the scaffold stays on disk, ready for `quickback build` later
|
|
29
29
|
|
|
30
30
|
**Example:**
|
|
31
31
|
```bash
|
|
@@ -58,14 +58,19 @@ This scaffolds a complete project with:
|
|
|
58
58
|
|
|
59
59
|
See the [Templates](/start/templates) page for a deeper guide on choosing between them.
|
|
60
60
|
|
|
61
|
-
###
|
|
61
|
+
### Build Your API
|
|
62
62
|
|
|
63
63
|
```bash
|
|
64
|
-
quickback
|
|
64
|
+
quickback build
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
-
|
|
68
|
-
|
|
67
|
+
> `quickback compile` is the former name of this command and still works as an
|
|
68
|
+
> alias — existing scripts and CI pipelines keep running unchanged. `build` is
|
|
69
|
+
> the name used throughout the docs.
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
Use `quickback build --verbose` when a remote build fails and you need the
|
|
73
|
+
underlying command, exit code, stderr/stdout tail, and suggested fixes.
|
|
69
74
|
|
|
70
75
|
Reads your definitions and generates:
|
|
71
76
|
- Database migrations (Drizzle)
|
|
@@ -126,8 +131,8 @@ no server: this is your editor's view of the source, on demand.
|
|
|
126
131
|
|
|
127
132
|
Exit codes: `0` clean · `1` type errors · `2` setup missing. A fresh clone
|
|
128
133
|
(or a project that has never compiled) exits `2` with a pointer at
|
|
129
|
-
`quickback
|
|
130
|
-
resolves against. Re-run `quickback
|
|
134
|
+
`quickback build`, which generates the tsconfig and helpers the check
|
|
135
|
+
resolves against. Re-run `quickback build` after schema changes so the
|
|
131
136
|
helpers track your tables.
|
|
132
137
|
|
|
133
138
|
### Synchronize Managed Columns
|
|
@@ -325,7 +330,7 @@ cd my-app
|
|
|
325
330
|
npm run dev
|
|
326
331
|
|
|
327
332
|
# 3. Recompile after editing definitions
|
|
328
|
-
quickback
|
|
333
|
+
quickback build
|
|
329
334
|
```
|
|
330
335
|
|
|
331
336
|
## Options
|
|
@@ -352,7 +357,7 @@ The CLI parses your feature files with the TypeScript compiler API, and falls ba
|
|
|
352
357
|
Set `QUICKBACK_STRICT_PARSE=1` in CI so a regex-parsed build fails the pipeline instead of shipping:
|
|
353
358
|
|
|
354
359
|
```bash
|
|
355
|
-
QUICKBACK_STRICT_PARSE=1 quickback
|
|
360
|
+
QUICKBACK_STRICT_PARSE=1 quickback build
|
|
356
361
|
```
|
|
357
362
|
|
|
358
363
|
Having no `typescript` installed at all is a supported setup and stays silent — the fallback is the intended path there.
|
|
@@ -363,11 +368,11 @@ Use an API key instead of interactive login. Useful for CI/CD pipelines and auto
|
|
|
363
368
|
|
|
364
369
|
```bash
|
|
365
370
|
# Pass API key for a single command
|
|
366
|
-
QUICKBACK_API_KEY=your_api_key quickback
|
|
371
|
+
QUICKBACK_API_KEY=your_api_key quickback build
|
|
367
372
|
|
|
368
373
|
# Or export for the session
|
|
369
374
|
export QUICKBACK_API_KEY=your_api_key
|
|
370
|
-
quickback
|
|
375
|
+
quickback build
|
|
371
376
|
```
|
|
372
377
|
|
|
373
378
|
The API key takes precedence over stored credentials from `quickback login`.
|
|
@@ -380,11 +385,11 @@ Point the CLI to a different compiler (local or custom):
|
|
|
380
385
|
|
|
381
386
|
```bash
|
|
382
387
|
# Use a local compiler
|
|
383
|
-
QUICKBACK_API_URL=http://localhost:3000 quickback
|
|
388
|
+
QUICKBACK_API_URL=http://localhost:3000 quickback build
|
|
384
389
|
|
|
385
390
|
# Or export for the session
|
|
386
391
|
export QUICKBACK_API_URL=http://localhost:3000
|
|
387
|
-
quickback
|
|
392
|
+
quickback build
|
|
388
393
|
```
|
|
389
394
|
|
|
390
395
|
See [Local Compiler](/tooling/cloud-compiler/local-compiler) for running the compiler locally with Docker.
|
|
@@ -407,7 +412,7 @@ npx @quickback-dev/cli start
|
|
|
407
412
|
|
|
408
413
|
1. Check your `quickback.config.ts` exists and is valid
|
|
409
414
|
2. Ensure all tables in `quickback/features/` have valid exports
|
|
410
|
-
3. Run `quickback
|
|
415
|
+
3. Run `quickback build` with `--verbose` for detailed output
|
|
411
416
|
4. For rename-related Drizzle failures in CI/headless runs, configure `compiler.migrations.renames` in `quickback.config.ts`
|
|
412
417
|
|
|
413
418
|
### Authentication issues
|
|
@@ -19,7 +19,7 @@ Credentials are stored at `~/.quickback/credentials.json` and include your sessi
|
|
|
19
19
|
For non-interactive environments (CI/CD, scripts), use an API key:
|
|
20
20
|
|
|
21
21
|
```bash
|
|
22
|
-
QUICKBACK_API_KEY=your_api_key quickback
|
|
22
|
+
QUICKBACK_API_KEY=your_api_key quickback build
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
Create API keys from your [Quickback account](https://account.quickback.dev/api-keys). Each key is scoped to your organization.
|
|
@@ -33,7 +33,7 @@ The `/compile` endpoint requires either a session token (from `quickback login`)
|
|
|
33
33
|
}
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
The map uses project-root-relative paths and follows the same layout `quickback
|
|
36
|
+
The map uses project-root-relative paths and follows the same layout `quickback build` reads from disk: `quickback/quickback.config.ts`, `quickback/features/**`, `quickback/services/**`, `quickback/{lib,hooks,plugins,middlewares,email-templates}/**`, plus `quickback/drizzle/**/meta/**` and `wrangler.toml` for incremental builds.
|
|
37
37
|
|
|
38
38
|
Two constraints, both fail-closed:
|
|
39
39
|
|
|
@@ -56,7 +56,9 @@ The response header `X-Quickback-Compile-Backend` says which backend answered:
|
|
|
56
56
|
| `container-fallback` | Edge is enabled but failed (5xx/unreachable); the container answered instead |
|
|
57
57
|
| _(absent)_ | Edge routing is not enabled; the container answered, as before |
|
|
58
58
|
|
|
59
|
-
Complete compiles (`?complete=true`, the default) always run in the container — they need the CLI toolchain (drizzle-kit, prebuilt SPA assets). The edge Worker rejects
|
|
59
|
+
Complete compiles (`?complete=true`, the default) always run in the container — they need the CLI toolchain (drizzle-kit, prebuilt SPA assets). For Cloudflare projects they also run `wrangler deploy --dry-run` as a bundle check (the same command package-mode deploy uses, without collecting a deployment artifact), so missing named exports and unresolved imports fail here instead of at deploy. The edge Worker rejects complete compiles with a 400 pointing at the container endpoint.
|
|
60
|
+
|
|
61
|
+
Validation compiles (`?complete=false`) still skip that bundle check — they may run on the edge Worker, which has no Wrangler.
|
|
60
62
|
|
|
61
63
|
## Environment Variables
|
|
62
64
|
|
|
@@ -70,7 +72,7 @@ Complete compiles (`?complete=true`, the default) always run in the container
|
|
|
70
72
|
Point the CLI to a different compiler (local or custom):
|
|
71
73
|
|
|
72
74
|
```bash
|
|
73
|
-
QUICKBACK_API_URL=http://localhost:3000 quickback
|
|
75
|
+
QUICKBACK_API_URL=http://localhost:3000 quickback build
|
|
74
76
|
```
|
|
75
77
|
|
|
76
78
|
See [Local Compiler](/tooling/cloud-compiler/local-compiler) for running the compiler locally with Docker.
|
|
@@ -91,7 +91,7 @@ npx @quickback-dev/cli start
|
|
|
91
91
|
npm install -g @quickback-dev/cli
|
|
92
92
|
quickback create cloudflare my-app
|
|
93
93
|
cd my-app
|
|
94
|
-
quickback
|
|
94
|
+
quickback build # prompts for login on the first run
|
|
95
95
|
```
|
|
96
96
|
|
|
97
97
|
## Existing Databases
|
|
@@ -35,14 +35,14 @@ bash dev.sh 3001
|
|
|
35
35
|
Point the CLI to your local compiler:
|
|
36
36
|
|
|
37
37
|
```bash
|
|
38
|
-
QUICKBACK_API_URL=http://localhost:3000 quickback
|
|
38
|
+
QUICKBACK_API_URL=http://localhost:3000 quickback build
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
Or export it for the session:
|
|
42
42
|
|
|
43
43
|
```bash
|
|
44
44
|
export QUICKBACK_API_URL=http://localhost:3000
|
|
45
|
-
quickback
|
|
45
|
+
quickback build
|
|
46
46
|
```
|
|
47
47
|
|
|
48
48
|
The supported launcher does not require `quickback login`. It opts the compiler
|
|
@@ -29,7 +29,7 @@ npx @quickback-dev/cli create cloudflare my-app
|
|
|
29
29
|
|
|
30
30
|
1. Check your `quickback.config.ts` exists and is valid
|
|
31
31
|
2. Ensure all tables in `quickback/features/` have valid exports
|
|
32
|
-
3. Run `quickback
|
|
32
|
+
3. Run `quickback build` with `--verbose` for detailed output
|
|
33
33
|
|
|
34
34
|
## Drizzle rename prompts in CI/headless compile
|
|
35
35
|
|
|
@@ -83,7 +83,52 @@ userId: q.text().required().references(() => users.id, { onDelete: 'cascade' })
|
|
|
83
83
|
generating features migrations.
|
|
84
84
|
|
|
85
85
|
A Start chat compile (`complete=false`) still succeeds — it never runs
|
|
86
|
-
drizzle-kit.
|
|
86
|
+
drizzle-kit. The complete compile (`complete=true` — Generated Backend, or
|
|
87
|
+
`quickback compile`) is the first time that command runs.
|
|
88
|
+
|
|
89
|
+
## `complete compile: wrangler bundle failed`
|
|
90
|
+
|
|
91
|
+
The complete compile bundles the generated Worker with
|
|
92
|
+
`wrangler deploy --dry-run`. A typical cause is a named import the generated
|
|
93
|
+
`define-action` helper does not re-export:
|
|
94
|
+
|
|
95
|
+
```
|
|
96
|
+
No matching export in "src/features/tables/.quickback/define-action.ts" for import "reservations"
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
The helper re-exports every table in **that feature only**. If `reservations`
|
|
100
|
+
is another table inside `tables`, import it from the action's own
|
|
101
|
+
`../.quickback/define-action` helper. If it belongs to a separate
|
|
102
|
+
`reservations` feature, keep `defineAction` from the action's own feature and
|
|
103
|
+
import only the external table from
|
|
104
|
+
`../../reservations/.quickback/define-action` (or the generated
|
|
105
|
+
`../../reservations/reservations` table module). Import query operators as `q`
|
|
106
|
+
from project `../../../lib/q`; neither feature helper owns them. This is the
|
|
107
|
+
same rule for any waitlist/reservations-style cross-feature action: the local
|
|
108
|
+
helper supplies the bound action context, and each external feature supplies
|
|
109
|
+
its own tables.
|
|
110
|
+
|
|
111
|
+
Current compilers validate named imports from generated action helpers before
|
|
112
|
+
code generation. Start's definition-validation build (`complete=false`)
|
|
113
|
+
therefore rejects this source immediately with `Invalid generated
|
|
114
|
+
action-helper import(s)` and names the owning feature, available table exports,
|
|
115
|
+
and corrective import. If an older compiler or an already-generated project
|
|
116
|
+
reaches Wrangler first, apply the same fix above and rebuild Generated Backend
|
|
117
|
+
before Deploy.
|
|
118
|
+
|
|
119
|
+
The compile sandbox has no network and bundles against the compiler image's
|
|
120
|
+
own dependencies, so anything you declare in
|
|
121
|
+
[`build.dependencies`](/configure#custom-dependencies) is not installed there.
|
|
122
|
+
Rather than fail on `Could not resolve "yjs"`, the compiler **skips** the
|
|
123
|
+
bundle check for those projects and says so in the compile warnings:
|
|
124
|
+
|
|
125
|
+
```
|
|
126
|
+
Skipped the Worker bundle check — build.dependencies not installed in the
|
|
127
|
+
compiler image: yjs, y-prosemirror
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
The compile still succeeds and the generated output is unchanged; unresolved
|
|
131
|
+
imports and missing named exports surface at `wrangler deploy` instead.
|
|
87
132
|
|
|
88
133
|
Store the Better Auth id as plain text:
|
|
89
134
|
|
|
@@ -36,6 +36,7 @@ src/
|
|
|
36
36
|
│ ├── types.ts # Runtime type definitions
|
|
37
37
|
│ ├── masks.ts # Field masking utilities
|
|
38
38
|
│ ├── services.ts # Service layer
|
|
39
|
+
│ ├── q.ts # Generated Drizzle query-operator namespace for actions
|
|
39
40
|
│ ├── audit-wrapper.ts # Stamps the managed audit columns on write
|
|
40
41
|
│ └── security-audit.ts # Unsafe cross-tenant audit logger (when needed)
|
|
41
42
|
└── middleware/
|
|
@@ -74,6 +75,13 @@ Not every per-feature file is always emitted:
|
|
|
74
75
|
- `schema.ts`, `{feature}.ts`, and `{feature}.resource.ts` are skipped for tableless features.
|
|
75
76
|
- A multi-table feature gets one alias file per table (`{feature}.ts`, `{other_table}.ts`) alongside the single `schema.ts`.
|
|
76
77
|
|
|
78
|
+
Each `.quickback/define-action.ts` helper is scoped to its feature: it exports
|
|
79
|
+
that feature's bound `defineAction` and tables, but no tables from sibling
|
|
80
|
+
features. A cross-feature action imports the external table from the sibling
|
|
81
|
+
feature's generated helper or table module. From a normal
|
|
82
|
+
`src/features/{feature}/actions/` file, import query operators with
|
|
83
|
+
`import { q } from "../../../lib/q"`.
|
|
84
|
+
|
|
77
85
|
## Spec Blobs Are Assets, Not Bundle
|
|
78
86
|
|
|
79
87
|
`openapi.json`, `asyncapi.json` and `schema-registry.json` are **not** written
|
|
@@ -163,6 +171,19 @@ unrecoverable while a missed one is only untidy:
|
|
|
163
171
|
|
|
164
172
|
Nothing under `src/` is ever listed: the wipe already covers it.
|
|
165
173
|
|
|
174
|
+
## Root files you own
|
|
175
|
+
|
|
176
|
+
A recompile rewrites `src/` wholesale, but three root files are merged rather
|
|
177
|
+
than replaced:
|
|
178
|
+
|
|
179
|
+
- **`package.json`** — compiler-owned scripts and dependencies converge on every
|
|
180
|
+
compile; scripts and fields the compiler does not emit are kept. Because owned
|
|
181
|
+
scripts converge, a hand-deleted `db:migrate:auth:*` step comes back — declare
|
|
182
|
+
[`authMigrations: 'external'`](/configure/providers#cloudflare-d1) instead.
|
|
183
|
+
- **`.gitignore`** — a union: your entries stay, missing compiler entries are
|
|
184
|
+
appended.
|
|
185
|
+
- **`README.md`** — written once; an existing README is never touched.
|
|
186
|
+
|
|
166
187
|
## Generated Package Dependency Security
|
|
167
188
|
|
|
168
189
|
For projects using Better Auth, the generated `package.json` keeps the stable
|
|
@@ -210,11 +231,11 @@ records the patched transitive version. Use `npm audit --omit=dev` when
|
|
|
210
231
|
evaluating the production dependency tree; development-tool advisories are a
|
|
211
232
|
separate review surface.
|
|
212
233
|
|
|
213
|
-
For Better Auth projects, `quickback
|
|
234
|
+
For Better Auth projects, `quickback build` owns auth-schema generation.
|
|
214
235
|
The generated `build` script runs TypeScript only and never rewrites
|
|
215
236
|
`src/auth/schema.ts`, so build and deployment preflight checks preserve a clean
|
|
216
237
|
generated worktree. `auth:schema` remains an explicit diagnostic command; run
|
|
217
|
-
`quickback
|
|
238
|
+
`quickback build` afterward to restore canonical generated bytes.
|
|
218
239
|
|
|
219
240
|
On recompilation, Quickback replaces commands for script names it generates,
|
|
220
241
|
including `build`, with the current compiler output. Scripts with other names
|
|
@@ -102,7 +102,7 @@ Quickback now adds a D1-specific safety pass around Drizzle-generated migrations
|
|
|
102
102
|
2. **Drop-only cleanup migrations** are reordered child-first when foreign keys require it.
|
|
103
103
|
3. **All D1 migration directories** generated by the compiler are replayed against SQLite during compile, so a D1-breaking migration fails before deploy.
|
|
104
104
|
|
|
105
|
-
If `quickback
|
|
105
|
+
If `quickback build` now fails with a D1 replay error, treat that as a real migration problem instead of a deploy-time surprise. The generated SQL needs manual intervention or a schema change that Drizzle can express more safely.
|
|
106
106
|
|
|
107
107
|
## Runtime Issues
|
|
108
108
|
|
|
@@ -281,11 +281,11 @@ VITE_DISABLE_EMAIL_STATUS_CHECK=false
|
|
|
281
281
|
The Account UI has no standalone deploy path — the compiler ships a generic prebuilt bundle (built once per compiler release) into your Worker. In a compiled project you normally set none of the variables on this page by hand:
|
|
282
282
|
|
|
283
283
|
1. Declare the values in `quickback.config.ts` under `account` (name, branding, URLs, `auth` feature flags).
|
|
284
|
-
2. `quickback
|
|
284
|
+
2. `quickback build` stages the prebuilt Account assets and bakes the values into the generated worker.
|
|
285
285
|
3. The worker injects them into every served Account shell as `window.__QUICKBACK_RUNTIME`, which the SPA prefers over baked `VITE_*` values. This runtime blob is the only per-project configuration channel — no per-project Vite build runs.
|
|
286
286
|
|
|
287
287
|
```bash
|
|
288
|
-
quickback
|
|
288
|
+
quickback build
|
|
289
289
|
npx wrangler deploy
|
|
290
290
|
```
|
|
291
291
|
|
|
@@ -85,7 +85,7 @@ The admin domain serves the same Account SPA at root (`/`). The SPA's client-sid
|
|
|
85
85
|
|
|
86
86
|
## CMS Access Control
|
|
87
87
|
|
|
88
|
-
When both CMS and Account UI are enabled, the
|
|
88
|
+
When both CMS and Account UI are enabled, the Account profile shows a CMS action. It opens the sole organization directly or lets a multi-organization user choose one first. You can restrict this to the sysadmin tier only:
|
|
89
89
|
|
|
90
90
|
```typescript
|
|
91
91
|
cms: { domain: "cms.example.com", access: "sysadmin" },
|