@quickback-dev/cli 0.66.1 → 0.66.3
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 +804 -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/actions.md +27 -3
- package/dist/skill/docs/api/batch-operations.md +4 -0
- package/dist/skill/docs/api/crud.md +64 -0
- package/dist/skill/docs/api/index.md +1 -1
- package/dist/skill/docs/api/openapi.md +1 -1
- package/dist/skill/docs/api/query-params.md +19 -2
- package/dist/skill/docs/changelog/index.md +33 -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 +3 -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 +39 -8
- 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 +34 -3
- package/dist/skill/docs/define/schema.md +29 -17
- 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 +40 -19
- 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 +32 -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/actions.md +27 -3
- package/src/skill/docs/api/batch-operations.md +4 -0
- package/src/skill/docs/api/crud.md +64 -0
- package/src/skill/docs/api/index.md +1 -1
- package/src/skill/docs/api/openapi.md +1 -1
- package/src/skill/docs/api/query-params.md +19 -2
- package/src/skill/docs/changelog/index.md +33 -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 +3 -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 +39 -8
- 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 +34 -3
- package/src/skill/docs/define/schema.md +29 -17
- 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 +40 -19
- 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 +32 -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,12 +1,22 @@
|
|
|
1
1
|
# Deploy from your browser
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Author and validate a backend in [Quickback Start](https://start.quickback.dev), build its complete generated output, and optionally ship that exact revision to **your own Cloudflare account** — databases created, migrations applied, secrets minted, Worker live on a `workers.dev` URL. No local tooling required.
|
|
4
4
|
|
|
5
5
|
This page covers the browser flow. For local projects, or anything the browser flow doesn't support yet, use [`quickback deploy`](/start/deploy) — the CLI covers every resource type and is always available.
|
|
6
6
|
|
|
7
7
|
> Browser deployment is new. The hosted deploy service sits behind a kill switch, and provisioning is rate-limited to 5 deploys per minute per user — enough to stop a runaway retry loop, not something a normal deploy will ever hit. `quickback deploy` works for everyone today.
|
|
8
8
|
|
|
9
9
|
|
|
10
|
+
## The three-stage workspace
|
|
11
|
+
|
|
12
|
+
Start keeps authoring, building, and deployment separate:
|
|
13
|
+
|
|
14
|
+
1. **Quickback Definitions** contains the files authored through chat: `quickback.config.ts`, features, schemas, access rules, actions, and other source definitions. Start validates these anonymously as they change. **Definitions valid** means the authored files pass this feedback loop; it is not a complete, downloadable backend build.
|
|
15
|
+
2. **Generated Backend** runs the hosted complete build. Sign in to your Quickback account here, click **Build generated backend**, then inspect or download the complete compiled backend preview artifact. After a successful build, **Rebuild** remains available in this tab so you can rerun the complete build even when the definitions have not changed. Each successful build approves the exact source revision and build identity for deployment. It also runs Wrangler's bundle check, so a missing export fails here — use **Send to agent** on the error — instead of later at Deploy. Quickback login authorizes this hosted build; it does not grant Cloudflare access and it is not the login for the app you generate.
|
|
16
|
+
3. **Cloudflare Infrastructure** is optional and comes last. Once a complete build is approved, connect Cloudflare, choose the account, and deploy from this tab. This stage reuses the approved revision and build identity, **not the bytes of the step-2 preview artifact**. It compiles the stored source once to prepare the deployment plan, provisions the real Cloudflare resources, then compiles it again with those resource ids to build and upload the Cloudflare package. All connection state, resources, progress, live URLs, and generated-app administrator credentials stay here.
|
|
17
|
+
|
|
18
|
+
All three tabs remain selectable before a build, so the later stages can explain what they need. Editing a definition after a successful build marks Generated Backend **stale** and blocks Cloudflare deployment until you rebuild. This guarantees that the source being deployed matches the revision you inspected.
|
|
19
|
+
|
|
10
20
|
## Browser vs CLI
|
|
11
21
|
|
|
12
22
|
| | Deploy from Start | `quickback deploy` |
|
|
@@ -19,24 +29,26 @@ This page covers the browser flow. For local projects, or anything the browser f
|
|
|
19
29
|
|
|
20
30
|
## How a deploy runs
|
|
21
31
|
|
|
22
|
-
|
|
32
|
+
After Generated Backend has a current complete build, open **Cloudflare Infrastructure** and click **Deploy this app**. The deployment pipeline runs four phases and reports each one:
|
|
23
33
|
|
|
24
|
-
1. **
|
|
34
|
+
1. **Preparing deployment plan** — Start performs the first deployment compile from the stored source for the exact revision approved in Generated Backend. It emits a *deployment manifest*: the exact set of resources, migrations, and secrets the deploy will touch. A changed or stale source hash is rejected before this begins. Anything the browser flow can't deploy fails **here**, with a named reason — never as a half-deployed app.
|
|
25
35
|
2. **Provision** — each D1 database, KV namespace, and R2 bucket is created in your account, or **adopted** if a resource with the same name already exists. Retries and redeploys never create duplicates. Nothing is ever deleted automatically.
|
|
26
|
-
3. **
|
|
36
|
+
3. **Building Cloudflare package** — Start performs the second deployment compile from the same approved source, now with the real resource ids folded into its deployment configuration. The result is the upload package: Worker modules plus your CMS/Account SPA assets, when enabled. It does not upload the step-2 preview artifact. Every byte is hash-verified against the manifest before anything is uploaded.
|
|
27
37
|
4. **Finalize** — migrations apply, the Worker uploads with its bindings, secrets are set, and the `workers.dev` route is enabled. Start probes the URL and only shows **Live** once it actually answers.
|
|
28
38
|
|
|
29
39
|
Provision hands back a one-time approval that finalize must present, so the upload can only ever be the one that was approved — being signed in is deliberately not enough on its own. The approval is good for an hour, which no normal deploy comes close to.
|
|
30
40
|
|
|
31
|
-
A typical deploy takes one to two minutes, most of it
|
|
41
|
+
A typical deploy takes one to two minutes, most of it the two deployment compiles and provisioning.
|
|
32
42
|
|
|
33
43
|
## Naming the Worker
|
|
34
44
|
|
|
35
|
-
The
|
|
45
|
+
The project `name` in `quickback/quickback.config.ts` decides what the deploy is called. That definition drives the Worker **and** every derived resource — `<name>-auth`, `<name>-features`, and any audit, webhook, or file-metadata databases your features pull in.
|
|
46
|
+
|
|
47
|
+
Cloudflare Infrastructure displays the derived Worker name read-only. To change it, edit the definition in chat or Quickback Definitions, validate again, and rebuild. The old complete build remains inspectable but becomes stale and cannot be deployed. This prevents a Cloudflare setting from silently changing the artifact you just reviewed.
|
|
36
48
|
|
|
37
|
-
|
|
49
|
+
Redeploying the same name updates the same app in place. Changing it deploys a **separate copy**: a new Worker, on new databases, at a new URL. The previous app keeps running untouched — nothing is renamed or deleted in your Cloudflare account, so a name you've finished with is yours to clean up in the dashboard.
|
|
38
50
|
|
|
39
|
-
Names follow Cloudflare's rule — lowercase letters, digits, hyphens, and underscores, starting with a letter or digit, up to 64 characters.
|
|
51
|
+
Names follow Cloudflare's rule — lowercase letters, digits, hyphens, and underscores, starting with a letter or digit, up to 64 characters.
|
|
40
52
|
|
|
41
53
|
## What deploys
|
|
42
54
|
|
|
@@ -46,7 +58,7 @@ Supported today, end to end:
|
|
|
46
58
|
|---|---|
|
|
47
59
|
| D1 databases | All of a project's databases — auth, features, and (when your features pull them in) audit, webhooks, and file-metadata |
|
|
48
60
|
| KV namespace | The `KV` binding for rate limiting and session overflow |
|
|
49
|
-
| R2 bucket | Managed file storage (`managed: true`) |
|
|
61
|
+
| R2 bucket | Managed file storage (`managed: true`). The bucket is created; the R2 API-token secrets (`R2_ACCOUNT_ID`, `R2_ACCESS_KEY_ID`, `R2_SECRET_ACCESS_KEY`) are **not**. Profile-picture and org-logo upload stay off unless those secrets are set — see [Avatars](/ui/account/features/avatars) |
|
|
50
62
|
| Realtime | The inline Broadcaster Durable Object, including its class registration |
|
|
51
63
|
| Email binding | The Cloudflare Email Service binding is attached (see the delivery caveat below) |
|
|
52
64
|
| CMS / Account UI | The bundled SPAs upload as static assets on the same Worker, with your app's real URL baked in |
|
|
@@ -61,7 +73,7 @@ Blocked, fail-closed at the compile phase — the deploy stops with the reason,
|
|
|
61
73
|
| Separate-worker realtime | Needs a second Worker + service binding |
|
|
62
74
|
| Custom `apps:` mounts | Typically need custom domains |
|
|
63
75
|
| Custom `bindings:` (Durable Objects, queues, services, extra R2 buckets) | Not represented by the deploy contract yet |
|
|
64
|
-
| Secrets you supply (third-party API keys, etc.) | The browser flow has no way to collect them yet — a project that *requires* one is refused rather than deployed broken |
|
|
76
|
+
| Secrets you supply (R2 API tokens, third-party API keys, etc.) | The browser flow has no way to collect them yet — a project that *requires* one is refused rather than deployed broken. For listing photos, store `q.url()` instead of enabling `fileStorage`, or download and `wrangler secret put` the three `R2_*` secrets |
|
|
65
77
|
| Hyperdrive, public R2 buckets, containers, workflows | Out of MVP scope |
|
|
66
78
|
|
|
67
79
|
> **Email delivery**: the email *binding* is attached so your app boots and auth works, but actually sending mail requires Email Sending to be configured on your Cloudflare account with a verified sending domain — which a fresh `workers.dev` app doesn't have. Start's builder defaults new apps to email + password **without** email verification for exactly this reason; enable verification, OTP, or magic links after you've configured a sending domain.
|
|
@@ -69,12 +81,12 @@ Blocked, fail-closed at the compile phase — the deploy stops with the reason,
|
|
|
69
81
|
|
|
70
82
|
## Connecting your Cloudflare account
|
|
71
83
|
|
|
72
|
-
|
|
84
|
+
Building and deploying use two deliberately separate identities:
|
|
73
85
|
|
|
74
|
-
- **
|
|
75
|
-
- **Grant deploy access** gives Quickback permission to deploy into your Cloudflare account
|
|
86
|
+
- **Sign in to Quickback** lives in Generated Backend and authorizes the hosted complete build. The account login page may offer several providers, but Start does not force Cloudflare as the login method.
|
|
87
|
+
- **Grant deploy access** lives in Cloudflare Infrastructure and gives Quickback permission to deploy into your Cloudflare account. It is a standard OAuth consent against Cloudflare's own dashboard, shown by the **Quickback** OAuth client. You pick the account, see exactly which permissions are requested, and can revoke at any time from Cloudflare under **My Profile → Access Management → Connected Applications** (or disconnect from Start).
|
|
76
88
|
|
|
77
|
-
|
|
89
|
+
The generated app's login is a third identity boundary. Its first administrator is created only during deployment and signs in to the app's own Account UI; see [Owner access](/start/deploy-owner-access).
|
|
78
90
|
|
|
79
91
|
What's requested, and why:
|
|
80
92
|
|
|
@@ -90,15 +102,15 @@ What's requested, and why:
|
|
|
90
102
|
|
|
91
103
|
Nothing broader is requested — no zone, DNS, billing, or account-management access.
|
|
92
104
|
|
|
93
|
-
If you cancel at Cloudflare's consent screen — or Cloudflare ends the attempt for any other reason — you land back in Start with
|
|
105
|
+
If you cancel at Cloudflare's consent screen — or Cloudflare ends the attempt for any other reason — you land back in Start with Cloudflare Infrastructure explaining what happened and a **Try again** button. Nothing is stored on a cancelled attempt, and a connection you already had is left untouched.
|
|
94
106
|
|
|
95
107
|
## Connection states and recovery
|
|
96
108
|
|
|
97
|
-
|
|
109
|
+
Cloudflare Infrastructure is the whole connection UI: it reports the state of your Cloudflare connection and offers exactly one thing to do about it.
|
|
98
110
|
|
|
99
111
|
| What you see | What happened | What to do |
|
|
100
112
|
|---|---|---|
|
|
101
|
-
| "Grant Quickback permission to deploy…" |
|
|
113
|
+
| "Grant Quickback permission to deploy…" | The complete build is ready, but no deploy permission is stored yet | **Grant deploy access** |
|
|
102
114
|
| Masked email badge, green | Connected and healthy | Deploy |
|
|
103
115
|
| Badge turns amber, "· reconnect" | Grant revoked in Cloudflare, or the connection was deleted (plain expiry never surfaces — tokens refresh server-side) | **Reconnect Cloudflare** — one consent, same connection record |
|
|
104
116
|
| "…also linked to a different Quickback login" | This Cloudflare account is connected under another Quickback account too — apps deployed there are listed there, not here | Nothing, unless an app you expected is missing: sign in with the Quickback account you deployed it from |
|
|
@@ -117,16 +129,16 @@ Deploy is disabled while a reconnect is pending, so a deploy never starts on a c
|
|
|
117
129
|
|
|
118
130
|
### Connecting more than one Cloudflare account
|
|
119
131
|
|
|
120
|
-
Connect a second Cloudflare login with **Connect another** and
|
|
132
|
+
Connect a second Cloudflare login with **Connect another** and Cloudflare Infrastructure adds a login picker above the account picker. Start remembers which one you deployed with last and preselects it.
|
|
121
133
|
|
|
122
|
-
|
|
134
|
+
Cloudflare connections are owned by the Quickback account used for the complete build. If an app you expect is missing, return to Generated Backend and confirm that you are signed into the Quickback account that deployed it.
|
|
123
135
|
|
|
124
136
|
### Disconnecting vs. revoking
|
|
125
137
|
|
|
126
138
|
Two different things, and you usually want both:
|
|
127
139
|
|
|
128
|
-
- **Disconnect** (in
|
|
129
|
-
- **Revoke** (Cloudflare dashboard → **My Profile → Access Management → Connected Applications**, linked from
|
|
140
|
+
- **Disconnect** (in Cloudflare Infrastructure) makes Quickback forget the connection and its stored token. It doesn't touch anything in your Cloudflare account, and it never touches deployed apps — they're plain Workers in your account and keep running.
|
|
141
|
+
- **Revoke** (Cloudflare dashboard → **My Profile → Access Management → Connected Applications**, linked from Cloudflare Infrastructure) withdraws the grant itself. The stored ciphertext becomes useless immediately; the next thing Start tries turns into a reconnect prompt.
|
|
130
142
|
|
|
131
143
|
## Where your token lives
|
|
132
144
|
|
|
@@ -138,11 +150,12 @@ The OAuth token never reaches your browser, the chat model, or the compiler. It
|
|
|
138
150
|
|
|
139
151
|
The grant is standing permission carried by short-lived credentials. The token that can actually touch your account expires every hour; the deploy service refreshes it server-side, so expiry never reaches you as a prompt — a leaked working token goes stale within the hour either way. What persists is the sealed refresh token, which can only mint the next short-lived token.
|
|
140
152
|
|
|
141
|
-
Revoking in Cloudflare (**My Profile → Access Management → Connected Applications**) kills the whole chain immediately — the stored ciphertext becomes useless, and
|
|
153
|
+
Revoking in Cloudflare (**My Profile → Access Management → Connected Applications**) kills the whole chain immediately — the stored ciphertext becomes useless, and Cloudflare Infrastructure turns the next failed call into a reconnect prompt. See [Connection states and recovery](#connection-states-and-recovery) for the full set.
|
|
142
154
|
|
|
143
155
|
## Secrets on the deployed app
|
|
144
156
|
|
|
145
157
|
- `BETTER_AUTH_SECRET` is minted by the deploy service — 256 bits of fresh entropy per app — and set on the Worker directly. It's never shown to the browser or stored in your project.
|
|
158
|
+
- **R2 presign secrets are not minted.** `defineFileStorage("cloudflare-r2")` requires `R2_ACCOUNT_ID`, `R2_ACCESS_KEY_ID`, and `R2_SECRET_ACCESS_KEY`. Cloudflare Infrastructure creates the bucket; it cannot create an R2 API token (Cloudflare OAuth has no API-Tokens-Write scope). Finalize stops with `user-secret-missing` until those exist. Store a `q.url()` on the listing instead, or download the project and `wrangler secret put` after creating a token at **R2 → Manage API Tokens**.
|
|
146
159
|
- **Existing Worker secrets are always preserved.** Cloudflare's upload API replaces a Worker's bindings wholesale; the deploy explicitly carries every existing secret across, so a redeploy can never silently delete a secret you set by hand.
|
|
147
160
|
|
|
148
161
|
## Redeploys are safe by construction
|
|
@@ -172,35 +185,17 @@ Click Deploy as often as you like:
|
|
|
172
185
|
|
|
173
186
|
## After it's live
|
|
174
187
|
|
|
175
|
-
|
|
188
|
+
Cloudflare Infrastructure keeps the deployed target for this chat, with links straight into its CMS, Account UI, and API. It is read from local storage rather than transient deployment progress, so it survives a reload — refreshing no longer loses the way back to your app.
|
|
176
189
|
|
|
177
190
|
Your app answers at `https://<app-name>.<your-subdomain>.workers.dev`:
|
|
178
191
|
|
|
179
192
|
- **API-only apps** serve a small landing page at `/` (browsers) and a JSON service descriptor (everything else), linking `/api/v1`, `/openapi.json`, and `/health` — never a bare 404 on first visit.
|
|
180
|
-
- **Apps with the Account UI or CMS** redirect `/` to the login page or CMS. Both ship by default from Start, at `/cms/` and `/account/`. The CMS
|
|
193
|
+
- **Apps with the Account UI or CMS** redirect `/` to the login page or CMS. Both ship by default from Start, at `/cms/` and `/account/`. The CMS admits organization members (`cms.access: "member"`) — your first deploy seeds you as `owner` of the first organization (and `user.role === "sysadmin"`) — see [Owner access](/start/deploy-owner-access).
|
|
181
194
|
- `/health` reports status and whether email is configured.
|
|
182
195
|
|
|
183
|
-
The deployed app is a normal Worker in *your* account: logs, metrics, and settings live in your Cloudflare dashboard
|
|
184
|
-
|
|
185
|
-
That handover works because a successful deploy writes the real Cloudflare resource ids back into your `quickback.config.ts`:
|
|
186
|
-
|
|
187
|
-
```ts title="quickback/quickback.config.ts"
|
|
188
|
-
database: {
|
|
189
|
-
name: "cloudflare-d1",
|
|
190
|
-
config: {
|
|
191
|
-
splitDatabases: true,
|
|
192
|
-
authBinding: "AUTH_DB",
|
|
193
|
-
featuresBinding: "DB",
|
|
194
|
-
authDatabaseId: "8f2c…", // written by the deploy
|
|
195
|
-
featuresDatabaseId: "b91e…", // written by the deploy
|
|
196
|
-
},
|
|
197
|
-
},
|
|
198
|
-
```
|
|
199
|
-
|
|
200
|
-
Those ids identify the exact databases serving your app, so the download, the file tree, and any copy you hand to another tool all carry them. Without them `quickback deploy` can only match your resources by *name* — which silently creates a second, empty set if you deploy from a different Cloudflare login or rename the app.
|
|
201
|
-
|
|
202
|
-
> Keep those id keys when you edit the config. Deleting them points your next deploy at fresh, empty databases rather than the ones holding your data. If they do go missing, redeploying from Start writes them back.
|
|
196
|
+
The deployed app is a normal Worker in *your* account: logs, metrics, and settings live in your Cloudflare dashboard. Click **Download complete .zip** in Generated Backend when you want a local copy. The reviewed definitions and build are immutable after deployment, so Cloudflare resource ids are not written back into them.
|
|
203
197
|
|
|
198
|
+
For ongoing CLI management, keep the same project name and deploy through the same Cloudflare account so `quickback deploy` can match the named resources. Renaming the project intentionally creates a separate app and resource set.
|
|
204
199
|
|
|
205
200
|
## Not yet available
|
|
206
201
|
|
|
@@ -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)
|
|
@@ -120,15 +125,31 @@ quickback check --watch # re-check on change (tsc --watch)
|
|
|
120
125
|
```
|
|
121
126
|
|
|
122
127
|
Runs `tsc` over `quickback/tsconfig.json` — the config the compiler emits on
|
|
123
|
-
every compile, which typechecks the tree you actually edit
|
|
124
|
-
|
|
125
|
-
|
|
128
|
+
every compile, which typechecks the tree you actually edit against two
|
|
129
|
+
generated typing surfaces:
|
|
130
|
+
|
|
131
|
+
- **Action typing** — the per-feature `.quickback/define-action` helpers:
|
|
132
|
+
`record`, `ctx`, `input`, and the scoped `db` typed against your tables.
|
|
133
|
+
- **Definition typing** — `quickback/.quickback/compiler/`, a
|
|
134
|
+
declaration-file snapshot of the compiler's real `@quickback/compiler`
|
|
135
|
+
surface. `import { feature, q, defineTable, defineConfig } from
|
|
136
|
+
"@quickback/compiler"` resolves in table files and `quickback.config.ts`,
|
|
137
|
+
so a bad builder call or an unknown resource-config key is a type error at
|
|
138
|
+
the desk, not a compile-round-trip later.
|
|
139
|
+
|
|
140
|
+
No compile, no server: this is your editor's view of the source, on demand.
|
|
126
141
|
|
|
127
142
|
Exit codes: `0` clean · `1` type errors · `2` setup missing. A fresh clone
|
|
128
143
|
(or a project that has never compiled) exits `2` with a pointer at
|
|
129
|
-
`quickback
|
|
130
|
-
resolves against. Re-run `quickback
|
|
131
|
-
|
|
144
|
+
`quickback build`, which generates the tsconfig, helpers, and compiler types
|
|
145
|
+
the check resolves against. Re-run `quickback build` after schema changes so
|
|
146
|
+
they track your tables.
|
|
147
|
+
|
|
148
|
+
Actions that still import a table from the authored feature file
|
|
149
|
+
(`import { tickets } from "../tickets"`) fail the check — the q-DSL feature
|
|
150
|
+
file has only a default export. Import the table from the typed helper
|
|
151
|
+
instead (`import { defineAction, tickets } from "../.quickback/define-action"`);
|
|
152
|
+
`quickback migrate helper-imports` rewrites the safe cases for you.
|
|
132
153
|
|
|
133
154
|
### Synchronize Managed Columns
|
|
134
155
|
|
|
@@ -325,7 +346,7 @@ cd my-app
|
|
|
325
346
|
npm run dev
|
|
326
347
|
|
|
327
348
|
# 3. Recompile after editing definitions
|
|
328
|
-
quickback
|
|
349
|
+
quickback build
|
|
329
350
|
```
|
|
330
351
|
|
|
331
352
|
## Options
|
|
@@ -352,7 +373,7 @@ The CLI parses your feature files with the TypeScript compiler API, and falls ba
|
|
|
352
373
|
Set `QUICKBACK_STRICT_PARSE=1` in CI so a regex-parsed build fails the pipeline instead of shipping:
|
|
353
374
|
|
|
354
375
|
```bash
|
|
355
|
-
QUICKBACK_STRICT_PARSE=1 quickback
|
|
376
|
+
QUICKBACK_STRICT_PARSE=1 quickback build
|
|
356
377
|
```
|
|
357
378
|
|
|
358
379
|
Having no `typescript` installed at all is a supported setup and stays silent — the fallback is the intended path there.
|
|
@@ -363,11 +384,11 @@ Use an API key instead of interactive login. Useful for CI/CD pipelines and auto
|
|
|
363
384
|
|
|
364
385
|
```bash
|
|
365
386
|
# Pass API key for a single command
|
|
366
|
-
QUICKBACK_API_KEY=your_api_key quickback
|
|
387
|
+
QUICKBACK_API_KEY=your_api_key quickback build
|
|
367
388
|
|
|
368
389
|
# Or export for the session
|
|
369
390
|
export QUICKBACK_API_KEY=your_api_key
|
|
370
|
-
quickback
|
|
391
|
+
quickback build
|
|
371
392
|
```
|
|
372
393
|
|
|
373
394
|
The API key takes precedence over stored credentials from `quickback login`.
|
|
@@ -380,11 +401,11 @@ Point the CLI to a different compiler (local or custom):
|
|
|
380
401
|
|
|
381
402
|
```bash
|
|
382
403
|
# Use a local compiler
|
|
383
|
-
QUICKBACK_API_URL=http://localhost:3000 quickback
|
|
404
|
+
QUICKBACK_API_URL=http://localhost:3000 quickback build
|
|
384
405
|
|
|
385
406
|
# Or export for the session
|
|
386
407
|
export QUICKBACK_API_URL=http://localhost:3000
|
|
387
|
-
quickback
|
|
408
|
+
quickback build
|
|
388
409
|
```
|
|
389
410
|
|
|
390
411
|
See [Local Compiler](/tooling/cloud-compiler/local-compiler) for running the compiler locally with Docker.
|
|
@@ -407,7 +428,7 @@ npx @quickback-dev/cli start
|
|
|
407
428
|
|
|
408
429
|
1. Check your `quickback.config.ts` exists and is valid
|
|
409
430
|
2. Ensure all tables in `quickback/features/` have valid exports
|
|
410
|
-
3. Run `quickback
|
|
431
|
+
3. Run `quickback build` with `--verbose` for detailed output
|
|
411
432
|
4. For rename-related Drizzle failures in CI/headless runs, configure `compiler.migrations.renames` in `quickback.config.ts`
|
|
412
433
|
|
|
413
434
|
### 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.
|