void 0.20.2 → 0.20.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/dist/{auth-cmd-gniL2fNt.mjs → auth-cmd-CzwquNiP.mjs} +3 -3
- package/dist/{auth-link-NZdjCmSc.mjs → auth-link-ElDTgF7j.mjs} +3 -3
- package/dist/{build-cmd-sI18tX_O.mjs → build-cmd-BpJe6boP.mjs} +1 -1
- package/dist/{cache-IHn5MwBC.mjs → cache-D98YTqeE.mjs} +1 -1
- package/dist/{cancel-deploy-C5qTOdLi.mjs → cancel-deploy-CPbEQLMG.mjs} +1 -1
- package/dist/cli/cli.mjs +27 -26
- package/dist/{client-dHfSJvAN.mjs → client-BQBrZoCX.mjs} +143 -78
- package/dist/{connect-Bfk31O_8.mjs → connect-WCQZ_u3m.mjs} +3 -3
- package/dist/{create-project-Bk9Z0-Jg.mjs → create-project-D0oXA090.mjs} +2 -3
- package/dist/{db-BkRoptAt.mjs → db-DJ-9qs3S.mjs} +2 -2
- package/dist/{delete-DouASY9P.mjs → delete-BZ4-WaGm.mjs} +1 -1
- package/dist/{deploy-DTaWUS1S.mjs → deploy-BAhhcg5q.mjs} +17 -10
- package/dist/{domain-1RhhOVrC.mjs → domain-BxAyhxXN.mjs} +1 -1
- package/dist/{email-C-lGh51B.mjs → email-Bj7Cvdwp.mjs} +2 -2
- package/dist/{env-DJHsPE7Z.mjs → env-DP_EErve.mjs} +1 -1
- package/dist/{github-cmd-PW7ZnWTp.mjs → github-cmd-C-z_xRrQ.mjs} +13 -19
- package/dist/index.mjs +4 -4
- package/dist/{init-BWZ7q5Z4.mjs → init-BGktCXgA.mjs} +4 -4
- package/dist/{link-Rmvu2Wl_.mjs → link-D2kbqhWb.mjs} +2 -2
- package/dist/{list-DEE2S6mY.mjs → list-CvkK_G7k.mjs} +1 -1
- package/dist/{login-Uvferzmm.mjs → login-WIjNc77c.mjs} +2 -2
- package/dist/{logs-27FenuiC.mjs → logs-dLUFCapG.mjs} +1 -1
- package/dist/{operator-cmd-CjOTmAYE.mjs → operator-cmd-CKJ7xIRs.mjs} +2 -2
- package/dist/{platform-auth-config-DrbQXXiW.mjs → platform-auth-config-CdVWRRJr.mjs} +2 -2
- package/dist/{platform-auth-protection-Bhtvp0B_.mjs → platform-auth-protection-Drl0qhrn.mjs} +2 -2
- package/dist/{platform-auth-recovery-CeOKGVeJ.mjs → platform-auth-recovery-CmKEWpDo.mjs} +2 -2
- package/dist/{platform-cmd-BFhieCdV.mjs → platform-cmd-5q_k56xS.mjs} +3 -3
- package/dist/{platform-domain-C74PULqV.mjs → platform-domain-4GiDlcqx.mjs} +2 -2
- package/dist/{platform-lifecycle-BwAIgz-t.mjs → platform-lifecycle-R9xAxvtG.mjs} +61 -25
- package/dist/{platform-management-COogu_Se.mjs → platform-management-BfWsXHEW.mjs} +5 -3
- package/dist/{platform-recovery-ewqLefp1.mjs → platform-recovery-CbK-I1FB.mjs} +2 -2
- package/dist/{project-cmd-DmZK9Hxf.mjs → project-cmd-CTdmnzvc.mjs} +12 -12
- package/dist/{project-team-D8jOJMUJ.mjs → project-team-CGxsQe3_.mjs} +4 -2
- package/dist/{project-token-DA34bf-C.mjs → project-token-Cirx7uwZ.mjs} +1 -1
- package/dist/{requests-CUExwGQQ.mjs → requests-4Nq59hOr.mjs} +1 -1
- package/dist/{rollback-CDNGU1gr.mjs → rollback-Dr7u0Ljx.mjs} +1 -1
- package/dist/runtime/remote/index.mjs +49 -8
- package/dist/runtime/sandbox.d.mts +4 -56
- package/dist/runtime/sandbox.mjs +81 -220
- package/dist/{secret-Bzzi2e9E.mjs → secret-AcPi-FoA.mjs} +1 -1
- package/package.json +7 -7
- package/skills/void/SKILL.md +2 -2
- package/skills/void/docs/guide/deployment.md +14 -14
- package/skills/void/docs/guide/email.md +12 -10
- package/skills/void/docs/guide/platform/administration/access.md +163 -0
- package/skills/void/docs/guide/platform/administration/email.md +121 -0
- package/skills/void/docs/guide/platform/administration/operations.md +97 -0
- package/skills/void/docs/guide/platform/administration/projects.md +54 -0
- package/skills/void/docs/guide/platform/development/local.md +119 -0
- package/skills/void/docs/guide/platform/development/runtime.md +124 -0
- package/skills/void/docs/guide/platform/development/schema-ci.md +95 -0
- package/skills/void/docs/guide/platform/installation/ci.md +55 -0
- package/skills/void/docs/guide/platform/installation/credentials.md +80 -0
- package/skills/void/docs/guide/platform/installation/domains.md +68 -0
- package/skills/void/docs/guide/platform/installation/first-deployment.md +82 -0
- package/skills/void/docs/guide/platform/installation/maintenance.md +137 -0
- package/skills/void/docs/guide/platform/installation/prerequisites.md +86 -0
- package/skills/void/docs/guide/platform/installation/setup.md +169 -0
- package/skills/void/docs/guide/platform/installation/uninstall.md +54 -0
- package/skills/void/docs/guide/platform-administration.md +6 -414
- package/skills/void/docs/guide/platform-development.md +5 -316
- package/skills/void/docs/guide/project-collaboration.md +1 -1
- package/skills/void/docs/guide/sandboxes.md +9 -24
- package/skills/void/docs/guide/self-hosted-platform.md +11 -694
- package/skills/void/docs/reference/api.md +34 -34
- package/skills/void/docs/reference/cli.md +28 -11
- package/skills/void/docs/reference/config.md +1 -1
- package/skills/void/docs/reference/resource-inference.md +10 -10
|
@@ -1178,37 +1178,37 @@ See [Markdown Pages](../guide/pages-routing/markdown.md) for setup and framework
|
|
|
1178
1178
|
|
|
1179
1179
|
This table lists app-facing imports. Exported implementation subpaths such as `void/pages*`, `void/runtime/*`, and `void/remote*` are used by adapters, generated entries, or internal runtime wiring and are not documented as application APIs.
|
|
1180
1180
|
|
|
1181
|
-
| Import path | Contents
|
|
1182
|
-
| ------------------------- |
|
|
1183
|
-
| `void` | `voidPlugin`, handler/type re-exports, `defer`, `Deferred`, `DeferredState`, `InferProps`, `HeadDescriptor`
|
|
1184
|
-
| `void/handler` | `defineHandler`, `defineMiddleware`, `basicAuth`, `defineScheduled`, `defineQueue`, `defineRender`, `defineHead`, types
|
|
1185
|
-
| `void/auth` | `defineAuth`, `getUser`, `getSession`, `requireAuth`, `AuthUser`, `AuthSession`, `AuthState`
|
|
1186
|
-
| `void/client` | `fetch`, `fetchStream`, `FetchError`, `auth`, `createAuthClient`, `AuthUser`, `AuthSession`, `AuthState`
|
|
1187
|
-
| `void/client/{framework}` | Same as `void/client`, with framework-specific Better Auth clients for `react`, `vue`, `svelte`, and `solid`
|
|
1188
|
-
| `void/ws` | `defineRoom`, `defineWebSocket`, `connect`, WebSocket context and connection types
|
|
1189
|
-
| `void/durable` | `defineDurableState`, typed state/RPC/context/migration types
|
|
1190
|
-
| `void/sse` | `eventStream`, `formatSse`, `formatSseText`, `getLastEventId`, `SseStreamClosedError`, SSE message and stream types
|
|
1191
|
-
| `void/sse/client` | `connectEventStream`, browser `EventSource` wrapper types
|
|
1192
|
-
| `void/live` | `defineLiveStream`, SSE topic fanout runtime types. Server-only.
|
|
1193
|
-
| `void/live/client` | `connectLiveStream`, browser helper for one SSE connection plus POST subscribe/unsubscribe control.
|
|
1194
|
-
| `void/response` | `convertReturnValue`
|
|
1195
|
-
| `void/validator` | `runValidation`, `ValidatorSlots`, `HandlerInput`
|
|
1196
|
-
| `void/drizzle-zod` | Re-exports [`drizzle-zod`](https://orm.drizzle.team/docs/zod) for schema-derived Zod validators for Drizzle tables
|
|
1197
|
-
| `void/drizzle-valibot` | Re-exports [`drizzle-valibot`](https://orm.drizzle.team/docs/typebox) for schema-derived Valibot validators for Drizzle tables
|
|
1198
|
-
| `void/drizzle-arktype` | Re-exports [`drizzle-arktype`](https://orm.drizzle.team/docs/arktype) for schema-derived ArkType validators for Drizzle tables
|
|
1199
|
-
| `void/schema-d1` | Re-exports [`drizzle-orm/sqlite-core`](https://orm.drizzle.team/docs/column-types/sqlite) for D1 table and column builders
|
|
1200
|
-
| `void/schema-pg` | Re-exports [`drizzle-orm/pg-core`](https://orm.drizzle.team/docs/column-types/pg) for PostgreSQL table and column builders
|
|
1201
|
-
| `void/schema-mysql` | Re-exports `drizzle-orm/mysql-core` for MySQL table and column builders
|
|
1202
|
-
| `void/database-provider` | `defineDatabaseProvider` and adapter types for `void db connect --provider`
|
|
1203
|
-
| `void/db` | `db` (Drizzle D1, PostgreSQL, or MySQL instance for the active dialect), `createDb`, query operators (`eq`, `and`, `or`, `desc`, `like`, `inArray`, etc.)
|
|
1204
|
-
| `void/seed` | `defineSeed`, `SeedContext`, `SeedFn` for programmatic `void db seed` modules
|
|
1205
|
-
| `void/kv` | `kv`, `createKV`, typed KV client/map types
|
|
1206
|
-
| `void/storage` | `storage`, `createStorage` for the inferred R2 binding or a specific `R2Bucket`
|
|
1207
|
-
| `void/ai` | `ai`, `VoidAi`, model input and response types
|
|
1208
|
-
| `void/isr` | `revalidate(options)` for on-demand ISR cache invalidation
|
|
1209
|
-
| `void/log` | `logger` structured logging helper
|
|
1210
|
-
| `void/routes` | `RouteMap` and `WebSocketRouteMap` stubs (types only)
|
|
1211
|
-
| `void/queues` | `queues` proxy for sending messages to typed queues
|
|
1212
|
-
| `void/sandbox` | `getSandbox`, `sandbox`, `Sandbox`, and sandbox option types from the Cloudflare Sandbox SDK. `getSandbox(id)` resolves to the same Durable Object instance for a given `id`
|
|
1213
|
-
| `void/env` | `defineEnv`, `env`, schema helpers (`string`, `number`, `boolean`, `url`, `email`, `oneOf`, `json`), and global Cloudflare env types
|
|
1214
|
-
| `void/sveltekit` | SvelteKit integration helpers: `withVoidTSConfig()` and `mergeVoidSvelteKitTsconfig()`
|
|
1181
|
+
| Import path | Contents |
|
|
1182
|
+
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1183
|
+
| `void` | `voidPlugin`, handler/type re-exports, `defer`, `Deferred`, `DeferredState`, `InferProps`, `HeadDescriptor` |
|
|
1184
|
+
| `void/handler` | `defineHandler`, `defineMiddleware`, `basicAuth`, `defineScheduled`, `defineQueue`, `defineRender`, `defineHead`, types |
|
|
1185
|
+
| `void/auth` | `defineAuth`, `getUser`, `getSession`, `requireAuth`, `AuthUser`, `AuthSession`, `AuthState` |
|
|
1186
|
+
| `void/client` | `fetch`, `fetchStream`, `FetchError`, `auth`, `createAuthClient`, `AuthUser`, `AuthSession`, `AuthState` |
|
|
1187
|
+
| `void/client/{framework}` | Same as `void/client`, with framework-specific Better Auth clients for `react`, `vue`, `svelte`, and `solid` |
|
|
1188
|
+
| `void/ws` | `defineRoom`, `defineWebSocket`, `connect`, WebSocket context and connection types |
|
|
1189
|
+
| `void/durable` | `defineDurableState`, typed state/RPC/context/migration types |
|
|
1190
|
+
| `void/sse` | `eventStream`, `formatSse`, `formatSseText`, `getLastEventId`, `SseStreamClosedError`, SSE message and stream types |
|
|
1191
|
+
| `void/sse/client` | `connectEventStream`, browser `EventSource` wrapper types |
|
|
1192
|
+
| `void/live` | `defineLiveStream`, SSE topic fanout runtime types. Server-only. |
|
|
1193
|
+
| `void/live/client` | `connectLiveStream`, browser helper for one SSE connection plus POST subscribe/unsubscribe control. |
|
|
1194
|
+
| `void/response` | `convertReturnValue` |
|
|
1195
|
+
| `void/validator` | `runValidation`, `ValidatorSlots`, `HandlerInput` |
|
|
1196
|
+
| `void/drizzle-zod` | Re-exports [`drizzle-zod`](https://orm.drizzle.team/docs/zod) for schema-derived Zod validators for Drizzle tables |
|
|
1197
|
+
| `void/drizzle-valibot` | Re-exports [`drizzle-valibot`](https://orm.drizzle.team/docs/typebox) for schema-derived Valibot validators for Drizzle tables |
|
|
1198
|
+
| `void/drizzle-arktype` | Re-exports [`drizzle-arktype`](https://orm.drizzle.team/docs/arktype) for schema-derived ArkType validators for Drizzle tables |
|
|
1199
|
+
| `void/schema-d1` | Re-exports [`drizzle-orm/sqlite-core`](https://orm.drizzle.team/docs/column-types/sqlite) for D1 table and column builders |
|
|
1200
|
+
| `void/schema-pg` | Re-exports [`drizzle-orm/pg-core`](https://orm.drizzle.team/docs/column-types/pg) for PostgreSQL table and column builders |
|
|
1201
|
+
| `void/schema-mysql` | Re-exports `drizzle-orm/mysql-core` for MySQL table and column builders |
|
|
1202
|
+
| `void/database-provider` | `defineDatabaseProvider` and adapter types for `void db connect --provider` |
|
|
1203
|
+
| `void/db` | `db` (Drizzle D1, PostgreSQL, or MySQL instance for the active dialect), `createDb`, query operators (`eq`, `and`, `or`, `desc`, `like`, `inArray`, etc.) |
|
|
1204
|
+
| `void/seed` | `defineSeed`, `SeedContext`, `SeedFn` for programmatic `void db seed` modules |
|
|
1205
|
+
| `void/kv` | `kv`, `createKV`, typed KV client/map types |
|
|
1206
|
+
| `void/storage` | `storage`, `createStorage` for the inferred R2 binding or a specific `R2Bucket` |
|
|
1207
|
+
| `void/ai` | `ai`, `VoidAi`, model input and response types |
|
|
1208
|
+
| `void/isr` | `revalidate(options)` for on-demand ISR cache invalidation |
|
|
1209
|
+
| `void/log` | `logger` structured logging helper |
|
|
1210
|
+
| `void/routes` | `RouteMap` and `WebSocketRouteMap` stubs (types only) |
|
|
1211
|
+
| `void/queues` | `queues` proxy for sending messages to typed queues |
|
|
1212
|
+
| `void/sandbox` | `getSandbox`, `sandbox`, `Sandbox`, and sandbox option types from the Cloudflare Sandbox SDK. `getSandbox(id)` resolves to the same Durable Object instance for a given `id` within a deployment. Native Cloudflare preserves the namespace across Worker versions; managed platform deployments use deployment-scoped namespaces. The container filesystem, processes, and exposed ports are tied to one container lifetime and are lost on idle (`sleepAfter`, default `10m`), crash, or platform restart. See [Sandboxes › State persistence](../guide/sandboxes.md#state-persistence). |
|
|
1213
|
+
| `void/env` | `defineEnv`, `env`, schema helpers (`string`, `number`, `boolean`, `url`, `email`, `oneOf`, `json`), and global Cloudflare env types |
|
|
1214
|
+
| `void/sveltekit` | SvelteKit integration helpers: `withVoidTSConfig()` and `mergeVoidSvelteKitTsconfig()` |
|
|
@@ -506,7 +506,7 @@ Browser login offers the platform's enabled methods; `--provider <connection-id>
|
|
|
506
506
|
|
|
507
507
|
`protection enable` creates or connects Cloudflare Access applications independently
|
|
508
508
|
of login methods. Its `--file` accepts the `cloudflareAccess` object described in
|
|
509
|
-
[installation setup](../guide/
|
|
509
|
+
[installation setup](../guide/platform/installation/setup.md#choose-login-methods).
|
|
510
510
|
Protection changes require installation ownership, the saved recovery credentials,
|
|
511
511
|
and a human administrator session. They revoke current human sessions. Before
|
|
512
512
|
removing protection, change any signup rule that depends on that gate. Cloudflare
|
|
@@ -521,7 +521,7 @@ original recovery keys, and a successful browser provider test. Use
|
|
|
521
521
|
|
|
522
522
|
`auth token` prints your current operator token. With `--token-stdin`, it exchanges a full administrator API login session from standard input for a new operator token. `auth login --token-stdin` saves the exchanged token to the keychain instead of printing it.
|
|
523
523
|
|
|
524
|
-
For automation, supply `VOID_OPERATOR_TOKEN` with an explicit `VOID_API_URL` or `--connection`. Operator tokens are stored separately from application deployment credentials. The API checks your current administrator access on every request. See [Using Scripts](../guide/platform
|
|
524
|
+
For automation, supply `VOID_OPERATOR_TOKEN` with an explicit `VOID_API_URL` or `--connection`. Operator tokens are stored separately from application deployment credentials. The API checks your current administrator access on every request. See [Using Scripts](../guide/platform/administration/operations.md#using-scripts) for an example.
|
|
525
525
|
|
|
526
526
|
#### Users {#operator-users}
|
|
527
527
|
|
|
@@ -711,12 +711,29 @@ void platform system sandbox-drain [--cursor <opaque-cursor>]
|
|
|
711
711
|
|
|
712
712
|
`events` shows the administrator, target, and outcome of changes. A pending event means the outcome has not been recorded. Previews and session login/logout do not create these events. `backfill-queue-tokens` repairs older queue entries that are missing authentication tokens and supports `--plan` before applying the repair.
|
|
713
713
|
|
|
714
|
-
Use `sandbox-drain` when an upgrade asks you to finish
|
|
715
|
-
|
|
716
|
-
<span id="operator-workers"></span>
|
|
714
|
+
Use `sandbox-drain` when an upgrade from the legacy tenant-owned Sandbox runtime asks you to finish cleanup. Preview with `--plan`; pass the returned `nextCursor` as `--cursor` to inspect later pages. Apply with `--yes` and rerun until it reports `complete: true`, then rerun the interrupted upgrade. Application traffic stays paused during cleanup, while administrator login remains available. The completed upgrade enables the current managed Sandbox controller automatically.
|
|
717
715
|
|
|
718
716
|
Use the [platform lifecycle commands](#lifecycle-commands) to maintain your installation's Workers.
|
|
719
717
|
|
|
718
|
+
#### Hosted Workers {#operator-workers}
|
|
719
|
+
|
|
720
|
+
The following commands manage the Workers of the hosted Void Cloud platform.
|
|
721
|
+
They are unavailable on a self-hosted installation; use the
|
|
722
|
+
[lifecycle commands](#lifecycle-commands) there instead.
|
|
723
|
+
|
|
724
|
+
```sh
|
|
725
|
+
void platform worker list [--environment <production|staging>]
|
|
726
|
+
void platform worker show <worker-name> [--environment <production|staging>]
|
|
727
|
+
void platform worker rollback <worker-name> <version-id> [--environment <production|staging>]
|
|
728
|
+
void platform worker rollback-all [--environment <production|staging>]
|
|
729
|
+
void platform worker events [batch-id] [--environment <production|staging>]
|
|
730
|
+
```
|
|
731
|
+
|
|
732
|
+
Use a name from `worker list`, such as `api` or `proxy`. `show` lists its
|
|
733
|
+
versions and current deployment. Preview either rollback with `--plan`, then
|
|
734
|
+
apply it interactively or with `--yes` in a script. `events` lists worker
|
|
735
|
+
operation events or inspects one batch by ID.
|
|
736
|
+
|
|
720
737
|
#### Pagination and JSON
|
|
721
738
|
|
|
722
739
|
User, project, deployment, invitation, and event lists default to page `1` with 20 items. `--limit` accepts 1 to 100 for these lists. Their JSON responses include the page, limit, and total count.
|
|
@@ -745,11 +762,11 @@ void platform install [options] [--yes]
|
|
|
745
762
|
| `--runtime <path>` | Deploy a locally built, integrity-checked runtime directory |
|
|
746
763
|
| `--yes` | Acknowledge Cloudflare changes in non-interactive use |
|
|
747
764
|
|
|
748
|
-
For a first installation, follow [Install a Void Platform](../guide/self-hosted-platform.md). The interactive installer recommends using a domain and offers **Use workers.dev for testing** as a visible alternative. Void creates the platform infrastructure and tables. External PostgreSQL and
|
|
765
|
+
For a first installation, follow [Install a Void Platform](../guide/self-hosted-platform.md). The interactive installer recommends using a domain and offers **Use workers.dev for testing** as a visible alternative. Void creates the platform infrastructure and tables. External PostgreSQL and a configured login method are required in either mode; GitHub OAuth is the default login choice, not a requirement. `--workers-dev` skips zone/DNS/certificate operations and cannot be combined with `--application-domain`, `--zone`, or `--dedicated-zone`.
|
|
749
766
|
|
|
750
767
|
Read-only plans, workers.dev installations with the default API hostname, and supported lifecycle operations can use Cloudflare browser login and the system keychain. Installation that writes DNS or creates a zone needs an explicit management token through `CLOUDFLARE_API_TOKEN` or `CF_API_TOKEN`.
|
|
751
768
|
|
|
752
|
-
The installed platform needs a separate runtime token to provision resources for apps. The interactive installer prompts for it and the other setup values. For non-interactive installs, inject the variables listed in [Install from CI](../guide/
|
|
769
|
+
The installed platform needs a separate runtime token to provision resources for apps. The interactive installer prompts for it and the other setup values. For non-interactive installs, inject the variables listed in [Install from CI](../guide/platform/installation/ci.md).
|
|
753
770
|
|
|
754
771
|
To enable email during install or upgrade, set both `VOID_EMAIL_SENDER_DOMAIN` and `VOID_EMAIL_SHARED_ZONE_ID`. Void records the pair for later upgrades; supplying only one is an error.
|
|
755
772
|
|
|
@@ -775,7 +792,7 @@ void platform domain set <domain> [--installation <id>] [--zone <domain>] [--ded
|
|
|
775
792
|
|
|
776
793
|
Add an application domain to a workers.dev test platform. Domain-based installations remain the recommended default. The command detects the zone when possible, creates missing DNS and routes after confirmation, and checks HTTPS before making the domain canonical. If DNS or certificates are pending, rerun the same command to resume. `--plan` is read-only; non-interactive mutations require `--yes`.
|
|
777
794
|
|
|
778
|
-
Existing workers.dev URLs remain available, and the platform API origin, OAuth callback, projects, and deployments stay unchanged. The command verifies the running runtime token's Cache Purge permission for the new zone. A disabled platform stays disabled. Use the database URL from the original installation when administering from another machine. Replacing an already configured application domain is not supported. See [
|
|
795
|
+
Existing workers.dev URLs remain available, and the platform API origin, OAuth callback, projects, and deployments stay unchanged. The command verifies the running runtime token's Cache Purge permission for the new zone. A disabled platform stays disabled. Use the database URL from the original installation when administering from another machine. Replacing an already configured application domain is not supported. See [Adding a Domain](../guide/platform/installation/domains.md#adding-a-domain).
|
|
779
796
|
|
|
780
797
|
### Lifecycle commands
|
|
781
798
|
|
|
@@ -811,7 +828,7 @@ Repair and upgrade preserve disabled state. New, resumed, and previously disable
|
|
|
811
828
|
|
|
812
829
|
Commands preserve existing routes and domains, verify the configured database, and coordinate concurrent administrators before making changes.
|
|
813
830
|
|
|
814
|
-
`--runtime` selects a custom platform build. Relative paths resolve from your current directory. Void verifies the build before making changes; see [Platform Development](../guide/platform
|
|
831
|
+
`--runtime` selects a custom platform build. Relative paths resolve from your current directory. Void verifies the build before making changes; see [Platform Development](../guide/platform/development/runtime.md#deploying-your-runtime) for creating one.
|
|
815
832
|
|
|
816
833
|
Without `--runtime`, the CLI uses its packaged platform version.
|
|
817
834
|
|
|
@@ -825,7 +842,7 @@ Uninstall verifies remote ownership before removing anything. Data resources are
|
|
|
825
842
|
|
|
826
843
|
Resources that may have been shared or repurposed are retained for manual review. Platform traffic stays blocked. External PostgreSQL and its data are never deleted.
|
|
827
844
|
|
|
828
|
-
See [Disable and
|
|
845
|
+
See [Disable and Uninstall](../guide/platform/installation/uninstall.md) for the full removal policy.
|
|
829
846
|
|
|
830
847
|
## Deploy
|
|
831
848
|
|
|
@@ -999,7 +1016,7 @@ Run ad-hoc SQL against the database. Provide SQL inline or from a file. SELECT q
|
|
|
999
1016
|
|
|
1000
1017
|
By default, targets the local database. Pass `--remote` to run against the deployed database selected in `.void/project.json`:
|
|
1001
1018
|
|
|
1002
|
-
- **
|
|
1019
|
+
- **Void platform D1 projects**: routes the query through the selected platform's registered proxy using your auth token. Void Cloud's proxy is `proxy.void.cloud`; a self-hosted platform uses its own proxy URL.
|
|
1003
1020
|
- **Direct Cloudflare D1 projects**: invokes Cloudflare against the pinned D1 binding from root `wrangler.jsonc`.
|
|
1004
1021
|
- **Hosted PostgreSQL and MySQL projects**: fetches the stored connection string from the platform and connects directly.
|
|
1005
1022
|
- **Direct Cloudflare PostgreSQL and MySQL projects**: uses `DATABASE_URL` from the current shell; Cloudflare cannot return the password from Hyperdrive.
|
|
@@ -247,7 +247,7 @@ Enable and configure Cloudflare Sandboxes for Void apps. Importing from `void/sa
|
|
|
247
247
|
| `instanceType` | `string` | `lite` on Void deploy |
|
|
248
248
|
| `maxInstances` | `number` | `20` on Void deploy |
|
|
249
249
|
|
|
250
|
-
Sandbox support currently applies to Void apps on the Cloudflare target. Native deployment requires [Workers Paid](https://dash.cloudflare.com/?to=/:account/workers/plans) because Cloudflare Containers are unavailable on Workers Free. `void deploy --platform cloudflare` verifies Containers access before provisioning resources or building the app and explains how to fix a missing plan or API-token permission. Apps that do not import `void/sandbox` or configure `sandbox` emit no Container and perform no entitlement check. The default registry image is pinned to the installed `@cloudflare/sandbox` version, so local and native Cloudflare deploys run the same container as Void Platform. If `sandbox.image` is a custom local Dockerfile path, set `sandbox.platformImage` to the pushed image that the platform should run.
|
|
250
|
+
Sandbox support currently applies to Void apps on the Cloudflare target. Native deployment requires [Workers Paid](https://dash.cloudflare.com/?to=/:account/workers/plans) because Cloudflare Containers are unavailable on Workers Free. `void deploy --platform cloudflare` verifies Containers access before provisioning resources or building the app and explains how to fix a missing plan or API-token permission. Managed deployment checks the platform account and runtime token only when a Sandbox app is deployed; the token needs Account / Containers: Edit and Account / Cloudchamber: Edit. Apps that do not import `void/sandbox` or configure `sandbox` emit no Container and perform no entitlement check. The default registry image is pinned to the installed `@cloudflare/sandbox` version, so local and native Cloudflare deploys run the same container as Void Platform. If `sandbox.image` is a custom local Dockerfile path, set `sandbox.platformImage` to the pushed image that the platform should run.
|
|
251
251
|
|
|
252
252
|
### `target`
|
|
253
253
|
|
|
@@ -18,16 +18,16 @@ This runs once before plugins initialize, so the results are available to config
|
|
|
18
18
|
|
|
19
19
|
## Detected Bindings
|
|
20
20
|
|
|
21
|
-
| Binding | Type
|
|
22
|
-
| ---------------- |
|
|
23
|
-
| `DB` | `D1Database`
|
|
24
|
-
| `KV` | `KVNamespace`
|
|
25
|
-
| `STORAGE` | `R2Bucket`
|
|
26
|
-
| `AI` | `Ai`
|
|
27
|
-
| `SANDBOX` |
|
|
28
|
-
| Auth | none
|
|
29
|
-
| `QUEUE_*` | `Queue`
|
|
30
|
-
| filename-derived | `DurableObjectNamespace`
|
|
21
|
+
| Binding | Type | Detected by import | Detected by env access |
|
|
22
|
+
| ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
|
23
|
+
| `DB` | `D1Database` | `import { db } from "void/db"` | `env.DB` or `c.env.DB` |
|
|
24
|
+
| `KV` | `KVNamespace` | `import { kv } from "void/kv"` | `env.KV` or `c.env.KV` |
|
|
25
|
+
| `STORAGE` | `R2Bucket` | `import { storage } from "void/storage"` | `env.STORAGE` or `c.env.STORAGE` |
|
|
26
|
+
| `AI` | `Ai` | `import { ai } from "void/ai"` | `env.AI` or `c.env.AI` |
|
|
27
|
+
| `SANDBOX` | Managed Sandbox capability | `import { getSandbox } from "void/sandbox"` | `getSandbox()`; native Cloudflare also exposes `env.SANDBOX` / `c.env.SANDBOX` |
|
|
28
|
+
| Auth | none | `import { ... } from "void/auth"` or `import { auth } from "void/client"` / `void/client/react` / `void/client/vue` / `void/client/svelte` / `void/client/solid` | none |
|
|
29
|
+
| `QUEUE_*` | `Queue` | `import { queues } from "void/queues"` | `env.QUEUE_*` |
|
|
30
|
+
| filename-derived | `DurableObjectNamespace` | A default-exported `defineDurableState()` module in `durable-objects/` | n/a |
|
|
31
31
|
|
|
32
32
|
Auth detection also triggers when importing the `auth` specifier from `void/client` or a framework-specific client subpath such as `void/client/react` (but not when importing only `fetch`).
|
|
33
33
|
|