Void

https://void.cloud
Admin
Void is a deployment platform designed for Vite, offering a powerful backend SDK to build and ship...
Tokens:217,957
Snippets:1,953
Trust Score:7.5
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### void github connect example with options

Source: https://void.cloud/reference/cli

Example of connecting a repository with explicit installation ID, repository, and branch. Useful for non-interactive or scripted usage.

```bash
void github connect my-app \
  --installation 42 \
  --repo owner/my-app \
  --branch main
```

--------------------------------

### Start interactive install for workers.dev

Source: https://void.cloud/guide/self-hosted-platform

Starts the interactive install for workers.dev testing and continues to the GitHub setup step. Use this command when you want to test on workers.dev.

```sh
void platform install --workers-dev
```

--------------------------------

### Example file tree (void app.js)

Source: https://void.cloud/integrations/nodejs-bun-deno

The example file tree structure for the API + Pages example with Node.js target and runtime, and 

```bash
my-app/
  pages/
    layout.tsx
    index.tsx
    index.server.ts
    about.tsx
    about.server.ts
  routes/
    api/
      hello.ts
  package.json
  vite.config.ts
  void.json
```

--------------------------------

### Set a custom domain with plan and without plan

Source: https://void.cloud/guide/self-hosted-platform

Run `void platform domain set` to add a domain. The `--plan` flag is optional and likely indicates a plan-based setup. The command selects the installed platform, finds or creates its zone, sets up DNS and routing, and verifies HTTPS before publishing new application URLs.

```sh
void platform domain set example.app --plan
void platform domain set example.app
```

--------------------------------

### Install @void/md with Solid adapter

Source: https://void.cloud/guide/pages-routing/markdown

Install the @void/md package alongside the Solid adapter.

```sh
npm install @void/md @void/solid
```

--------------------------------

### Preview a new installation with the built CLI

Source: https://void.cloud/guide/platform-development

Use the built CLI to preview a new installation from the runtime files. Replace the domain and zone with your own.

```sh
void-dev platform install \
  --name my-team \
  --application-domain example.app \
  --zone example.app \
  --runtime packages/platform/dist/runtime \
  --plan
```

--------------------------------

### Resume interrupted installation with void platform install

Source: https://void.cloud/guide/self-hosted-platform

Resumes a paused or interrupted installation using the installation ID printed by Void. Requires the management token to be available and the same `--runtime` directory if using a source build.

```sh
void platform install --resume --name <installation-id>
```

--------------------------------

### First deploy: void init and void deploy

Source: https://void.cloud/guide/deployment

Initializes deployment setup and deploys to the saved platform. During setup, choose Cloudflare (default), Void, or Skip. The choice is saved in `.void/project.json`.

```bash
void init   # choose Cloudflare (default), Void, or Skip deployment setup
void deploy # builds and deploys to the saved platform
```

--------------------------------

### Run the Void API locally with vp run --filter @voidcloud/api

Source: https://void.cloud/guide/platform-development

Creates the development database, applies migrations, seeds an administrator, and starts the API locally. The dev command disables optional build containers, so basic API and admin work does not require Docker. Setup writes local development values to the API and dashboard .dev.vars files, including the development authentication bypass and local database connection.

```sh
vp run --filter @voidcloud/api setup --admin-email dev@example.com
vp run --filter @voidcloud/api dev --local --enable-containers=false --host localhost --port 8787
```

--------------------------------

### Install Void platform with CLI

Source: https://void.cloud/guide/self-hosted-platform

Use this command to install the Void platform with specified options. Requires --yes for CI mutations; --plan is read-only. Custom runtimes require --runtime. Register the GitHub callback shown by --plan before unattended install.

```sh
void platform install \
  --name team \
  --display-name "Team Void" \
  --account <account-id> \
  --application-domain example.app \
  --zone example.app \
  --yes
```

--------------------------------

### void github installations

Source: https://void.cloud/reference/cli

Lists all GitHub App installations linked to your account. Each entry includes the `[id: <installation_id>]` needed for `--installation` in non-interactive use.

```bash
void github installations
```

--------------------------------

### Preview an upgrade for an existing installation

Source: https://void.cloud/guide/platform-development

Preview an upgrade using the installation ID and the runtime build.

```sh
void-dev platform upgrade <installation-id> \
  --runtime packages/platform/dist/runtime --plan
```

--------------------------------

### Create a new TanStack Start project

Source: https://void.cloud/integrations/frameworks/tanstack-start

Commands to scaffold a new TanStack Start project and navigate into it.

```bash
npm create @tanstack/start@latest my-app
cd my-app
```

--------------------------------

### void project requests examples

Source: https://void.cloud/reference/cli

Example invocations: filter by 5xx status and set a 24-hour range.

```bash
void project requests --status 5xx
void project requests --range 24h
```

--------------------------------

### Install @void/md with Svelte adapter

Source: https://void.cloud/guide/pages-routing/markdown

Install the @void/md package alongside the Svelte adapter.

```sh
npm install @void/md @void/svelte
```

--------------------------------

### Install @void/md with React adapter

Source: https://void.cloud/guide/pages-routing/markdown

Install the @void/md package alongside the React adapter.

```sh
npm install @void/md @void/react
```

--------------------------------

### Install framework adapter packages

Source: https://void.cloud/guide/pages-routing/overview

Install the framework adapter package for React, Vue, Svelte, or Solid alongside void when adding Pages mode manually.

```sh
npm install @void/react
```

```sh
npm install @void/vue
```

```sh
npm install @void/svelte
```

```sh
npm install @void/solid
```

--------------------------------

### Install Void GitHub App

Source: https://void.cloud/guide/deployment

Installs the Void GitHub App. Opens GitHub in the browser to select the account/organization and grant repository access.

```bash
void github install
```

--------------------------------

### Install SvelteKit Cloudflare adapter and Void

Source: https://void.cloud/integrations/frameworks/sveltekit

Installs the Cloudflare adapter and Void as dev dependencies.

```bash
npm install -D @sveltejs/adapter-cloudflare void
```

--------------------------------

### Deploy output after email setup

Source: https://void.cloud/guide/email

Shows the deployment output after accepting the email setup prompt, including the deployed worker, inbound routing rule, and outbound binding.

```text
  ✔ deployed  acme-support
    inbound   support@mail.acme.com  →  email/support+[ticket].ts
    outbound  sendEmail() from support@mail.acme.com
```

--------------------------------

### Set up the Void repository with vp install and void-dev

Source: https://void.cloud/guide/platform-development

Clones the Void repository fork and installs workspace dependencies. The installer builds the CLI, shared packages, and platform runtime, then makes the built CLI globally available as void-dev. It refuses to replace an unrelated global command; remove only this checkout's alias with vpr uninstall:void-dev.

```sh
git clone https://github.com/your-org/void.git
cd void
vp install
vpr install:void-dev
void-dev --help
```

--------------------------------

### CI commands for deploying source builds

Source: https://void.cloud/guide/platform-development

Commands to build the core, set environment variables, discover the installation, and upgrade with a custom runtime. Requires CLOUDFLARE_API_TOKEN and VOID_PLATFORM_DATABASE_URL in the CI environment. Omit the installation selector only if the account has one discoverable installation.

```sh
vp run build:core

export VOID_PLATFORM_REGISTRY_DIR="$RUNNER_TEMP/void-platform-registry"
export VOID_PLATFORM_RECOVERY_KEY="$(openssl rand -base64 32)"
node packages/void/dist/cli/cli.mjs platform discover --account "$CLOUDFLARE_ACCOUNT_ID" \
  --installation "$VOID_PLATFORM_INSTALLATION"
node packages/void/dist/cli/cli.mjs platform upgrade "$VOID_PLATFORM_INSTALLATION" \
  --runtime packages/platform/dist/runtime --plan
node packages/void/dist/cli/cli.mjs platform upgrade "$VOID_PLATFORM_INSTALLATION" \
  --runtime packages/platform/dist/runtime --yes
```

--------------------------------

### void.json configuration example

Source: https://void.cloud/integrations/nodejs-bun-deno

Example void.json configuration file with the target set to node. This is the configuration file used to specify the build target.

```json
// void.json
{ "target": "node" }
```

--------------------------------

### Hydration strategy import examples

Source: https://void.cloud/guide/pages-routing/islands

Example imports using `idle`, `media`, and `visible` hydration strategies for different components.

```tsx
import CookieBanner from './_CookieBanner' with { island: 'idle' };
import MobileMenu from './_MobileMenu' with { island: 'media:(max-width: 768px)' };
import Comments from './_Comments' with { island: 'visible' };
```

--------------------------------

### Interactive prompt: choose where apps live

Source: https://void.cloud/guide/self-hosted-platform

The installer's first prompt asks where your apps should live, with the domain option selected by default. This is part of the interactive installation flow.

```text
Where should your apps live?
  Use a domain — recommended
  Use workers.dev for testing — add a domain later
```

--------------------------------

### wrangler.jsonc example

Source: https://void.cloud/integrations/cloudflare

Example configuration showing an existing D1 binding while referencing a missing KV cache. Void leaves configured bindings unchanged, while adding a missing placeholder.

```jsonc
{
  "name": "my-app",
  "d1_databases": [
    {
      "binding": "DB",
      "database_name": "my-app-db",
      "database_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    },
  ],
  // Service bindings, routes, etc. are also preserved
  "services": [{ "binding": "API", "service": "my-api-worker" }],
}

```

--------------------------------

### Define a GET handler

Source: https://void.cloud/guide/server-routing

Example of a basic route handler for the GET method in routes/api/hello.ts.

```typescript
// routes/api/hello.ts  →  GET /api/hello
import { defineHandler } from 'void';

export const GET = defineHandler((c) => {
  return { message: 'Hello!', timestamp: Date.now() };
});
```

--------------------------------

### Run void init with npm

Source: https://void.cloud/guide/quickstart

Run the Void setup command using npx. Prompts for Vite+ or plain Vite, UI framework, starter, and deployment target.

```sh
npx void init
```

--------------------------------

### Start the dashboard dev server

Source: https://void.cloud/guide/platform-development

Run this command in a separate terminal after API setup to start the dashboard development server.

```sh
vp run --filter @voidcloud/dashboard dev
```

--------------------------------

### Run void init with bun

Source: https://void.cloud/guide/quickstart

Run the Void setup command using bunx. Prompts for Vite+ or plain Vite, UI framework, starter, and deployment target.

```sh
bunx void init
```

--------------------------------

### Define GET handler for API route

Source: https://void.cloud/guide/quickstart

Example GET handler for routes/api/hello.ts using defineHandler from 'void'. Returns a JSON message.

```ts
import { defineHandler } from 'void';

export const GET = defineHandler(() => {
  return { message: 'Hello from Void' };
});
```

--------------------------------

### Initialize and deploy with Void CLI

Source: https://void.cloud/guide

Initialize your app with the Void CLI, choosing your framework and deployment target, then deploy.

```sh
void init   # choose your framework and deployment target
void deploy
```

--------------------------------

### Run void init with pnpm

Source: https://void.cloud/guide/quickstart

Run the Void setup command using pnpm. Prompts for Vite+ or plain Vite, UI framework, starter, and deployment target.

```sh
pnpm void init
```

--------------------------------

### Define multiple HTTP method handlers

Source: https://void.cloud/guide/server-routing

Example of exporting both GET and POST handlers within a single file for routes/api/users/index.ts.

```typescript
// routes/api/users/index.ts  →  GET + POST /api/users
import { defineHandler } from 'void';
import { db } from 'void/db';
import { users } from '@schema';

export const GET = defineHandler(async () => {
  return await db.select().from(users);
});

export const POST = defineHandler(async (c) => {
  const body = await c.req.json();
  await db.insert(users).values({ name: body.name });
  return { created: true };
});
```

--------------------------------

### Access dynamic route params with useParams()

Source: https://void.cloud/guide/pages-routing/overview

Use `useParams()` from the same adapter package to access dynamic route parameters. The example shows a React component using `useParams` to get the `id` param.

```tsx
import { useParams } from '@void/react';

export default function PostPage() {
  const { id } = useParams<{ id: string }>();
  return <h1>Post {id}</h1>;
}
```

--------------------------------

### Access bindings in a TanStack Start server function

Source: https://void.cloud/integrations/cloudflare

In framework mode, server functions can import from cloudflare:workers. This example defines a server function that queries a D1 database and returns the results.

```tsx
// src/routes/users.tsx (TanStack Start)
import { createFileRoute } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { env } from 'cloudflare:workers';

const getUsers = createServerFn().handler(async () => {
  const { results } = await env.DB.prepare('SELECT * FROM users').all();
  return results;
});

export const Route = createFileRoute('/users')({
  loader: () => getUsers(),
  component: UsersPage,
});
```

--------------------------------

### Run void init with yarn

Source: https://void.cloud/guide/quickstart

Run the Void setup command using yarn. Prompts for Vite+ or plain Vite, UI framework, starter, and deployment target.

```sh
yarn void init
```

--------------------------------

### TypeScript setup for typed bindings

Source: https://void.cloud/integrations/cloudflare

Add "void/env" to your tsconfig types to get typed bindings on env. This augments the Cloudflare.Env interface with DB, KV, STORAGE, AI, and QUEUE_* and pulls in @cloudflare/workers-types.

```json
{
  "compilerOptions": {
    "types": ["void/env"]
  }
}
```

--------------------------------

### First deploy output: email setup plan

Source: https://void.cloud/guide/email

Shows what the deploy reads and prints before making changes, including the plan to enable Email Routing, subaddressing, Email Sending, and update wrangler.jsonc.

```text
  Email in use   email/support+[ticket].ts · email/_default.ts · sendEmail() in 2 files
    domain    mail.acme.com          (void.json email.from)
    zone      acme.com               account Acme (f721b8e5…) · session dev@acme.com
    apex MX   aspmx.l.google.com     left alone — mail lives on the subdomain
    routing   mail.acme.com  not enabled · subaddressing off
    sending   mail.acme.com  not onboarded
    rules     support@mail.acme.com → acme-support   (absent)
    binding   SEND_EMAIL             (absent)
    sender    noreply@mail.acme.com  (vars.__VOID_EMAIL_FROM absent)

  This changes YOUR Cloudflare account. acme.com itself is not touched.
    + enable Email Routing on mail.acme.com       Cloudflare writes and locks 3 MX + 1 SPF record there
    + turn on subaddressing for acme.com          support+anything@ reaches support@
    + onboard mail.acme.com for Email Sending     MX/SPF/DKIM on cf-bounce.mail.acme.com, _dmarc.mail.acme.com (p=reject)
    + wrangler.jsonc                              send_email: [{ name: "SEND_EMAIL" }], addresses: ["support@mail.acme.com"], vars.__VOID_EMAIL_FROM: "noreply@mail.acme.com"
    + routing rule (created on deploy)            support@mail.acme.com → acme-support
    ! email/_default.ts                           a catch-all exists only on an apex; other @mail.acme.com mail bounces
```

--------------------------------

### Access bindings via cloudflare:workers import

Source: https://void.cloud/integrations/cloudflare

When using framework mode (TanStack Start or React Router), the framework owns routing and you access bindings through the cloudflare:workers module. This example queries a D1 database.

```ts
import { env } from 'cloudflare:workers';

const result = await env.DB.prepare('SELECT * FROM users').all();
```

--------------------------------

### Build and run on Bun

Source: https://void.cloud/integrations/nodejs-bun-deno

For Bun, use `bunx` and run the commands from your working directory.

```bash
bunx vite build
bun dist/ssr/index.js
```

--------------------------------

### Versioned state migrations with defineDurableState

Source: https://void.cloud/guide/durable-state

Shows how to version persisted state when its shape changes. Versions start at 1, must be contiguous, and run in order before an operation handles the migrated state. The example defines migrations for versions 1 and 2 and a read method.

```ts
export const Counter = defineDurableState({
  initialState: { count: 0, label: 'Counter' },
  version: 2,
  migrations: [
    {
      version: 1,
      migrate(old) {
        return { count: (old as { count: number }).count, label: 'Counter' };
      },
    },
    {
      version: 2,
      migrate(old) {
        return { ...(old as { count: number; label: string }), label: 'Total' };
      },
    },
  ],
  methods: {
    read(context) {
      return context.state;
    },
  },
});

export default Counter;
```

--------------------------------

### Deploy failure summary output

Source: https://void.cloud/reference/cli

Example output shown when a deploy fails after it starts. The CLI prints a summary of the deploy trace under the error, including every error record with its flattened cause chain and the last 20 records as a timeline. Pre-flight failures and build failures print no summary.

```text
■  deploy: Deploy failed: deploy in progress
│  Deployment: dpl_7zgitxdrxxz9
│  Detailed log: ~/.void/logs/deploy-2026-08-21T03-24-19-764Z.jsonl
│
│  Errors
│     9.0s  deploy_server_error
│           deploymentId=dpl_7zgitxdrxxz9
│           message=deploy in progress
│
│  Last 20 of 26 entries
│     8.4s  info   finalize_start        assets=98 workers=0
│     8.6s  info   stream_deployment_id  deploymentId=dpl_7zgitxdrxxz9
│     9.0s  error  deploy_server_error   message=deploy in progress
```

--------------------------------

### Create a new SvelteKit project

Source: https://void.cloud/integrations/frameworks/sveltekit

Initializes a new SvelteKit project with `sv create` and navigates into the project directory.

```bash
npx sv create my-app
cd my-app
```

--------------------------------

### void email setup --platform cloudflare

Source: https://void.cloud/reference/cli

The same setup `void deploy --platform cloudflare` offers on its first deploy, on its own — for CI, which cannot press Enter: run it locally once, commit `wrangler.jsonc`, then let CI run `void deploy --platform cloudflare --require-email`. Needs `email.from` in `void.json` and a `void cloudflare login` session (a session created by older Cloudflare tooling lacks the email scopes: `void cloudflare logout`, then sign in again) or a `CLOUDFLARE_API_TOKEN` with Email Routing Edit + Email Sending Edit — the CI credential. It runs the preflight above, prints the checklist of what will change on your account, asks once, then: 1. enables Email Routing on the domain (on an apex through Void's bundled Cloudflare tooling; a subdomain through your session's bearer, borrowed for that one call and dropped), 2. turns on subaddressing for the zone, so `support+anything@` reaches `support@`, 3. onboards the domain for Email Sending (a Workers Free account keeps inbound and sends to verified destinations only), 4. writes `send_email: [{ "name": "SEND_EMAIL" }]`, the derived `addresses` array, and `vars.__VOID_EMAIL_FROM` into your root `wrangler.jsonc`, comments preserved.

```bash
void email setup --platform cloudflare
```

--------------------------------

### Initialize Void agent setup with npx void init --agents

Source: https://void.cloud/integrations/agents

Run this command to create or update AGENTS.md with Void instructions and reference docs. It preserves existing content outside the versioned Void block and leaves other instruction files untouched. There is no coding-agent selection prompt.

```sh
npx void init --agents
```

--------------------------------

### Install with nested application domain

Source: https://void.cloud/guide/self-hosted-platform

Use `void platform install` with `--application-domain` and `--zone` to configure a nested application domain like `apps.example.com` within an existing zone. The management token needs SSL and Certificates Read (or Edit) permission on that zone for the certificate check.

```sh
void platform install --application-domain apps.example.com --zone example.com --plan
```

--------------------------------

### Discover installation from another machine

Source: https://void.cloud/guide/self-hosted-platform

Restores local installation records after verifying resources belong to your platform. Works for interrupted or disabled installations.

```sh
void platform discover --account <account-id> --installation <id-or-name>
```

--------------------------------

### Join existing Void GitHub App installation

Source: https://void.cloud/guide/deployment

Joins an existing organization installation of the Void GitHub App when someone already installed it.

```bash
void github join
```

--------------------------------

### Create a new Analog project

Source: https://void.cloud/integrations/frameworks/analog

Creates a new Analog project named my-app and navigates into it.

```bash
npx create-analog@latest my-app
cd my-app
```

--------------------------------

### Build and run on Deno

Source: https://void.cloud/integrations/nodejs-bun-deno

For Deno, use `deno run -c` and run the commands from your working directory.

```bash
deno run -A npm:vite build
deno run -A dist/ssr/index.js
```

--------------------------------

### Resume an installation

Source: https://void.cloud/guide/self-hosted-platform

Use this command to continue a paused or failed installation from its saved progress. Omit the ID when only one installation is configured, or pass the ID interactively or via CI.

```sh
void platform install --resume --name <id>
```

--------------------------------

### Connect and deploy first app

Source: https://void.cloud/guide/self-hosted-platform

Connects to the platform API URL and deploys the first project. Confirms project creation when prompted.

```sh
void connect https://void-company-api.example.workers.dev
void deploy --platform void --project my-first-app
```

--------------------------------

### void deploy pipeline for SvelteKit, Nuxt, Analog, and Astro

Source: https://void.cloud/integrations/frameworks/overview

Shows the six-step deployment pipeline for SvelteKit, Nuxt, Analog, and Astro apps. The pipeline detects the framework from package.json, builds using the framework's command or a void.json override, analyzes output paths and bindings, optionally wraps the worker for crons/queues, packages and uploads with hash-based diffing, and finally provides a live URL.

```text
void deploy
  │
  ├─ 1. Detect framework
  │    Reads package.json → determines framework + output conventions
  │
  ├─ 2. Build
  │    Runs framework's build command (or void.json `build` override)
  │    SvelteKit: vite build → .svelte-kit/cloudflare/
  │    Nuxt:      nuxt build → .output/
  │    Analog:    vite build → dist/analog/
  │    Astro:     astro build → dist/
  │
  ├─ 3. Analyze
  │    ├─ Locate worker entry + static assets from known output paths
  │    ├─ Infer bindings from source or read from void.json
  │    ├─ Collect migrations from db/migrations/*.sql
  │    ├─ Detect cron and queue handlers
  │    └─ Read wrangler.jsonc compat settings
  │
  ├─ 4. Wrap (if needed)
  │    If crons or queues are configured:
  │    ├─ Generate wrapper entry module
  │    ├─ Bundle with Vite (wraps framework's worker)
  │    └─ Wrapper adds scheduled/queue handlers
  │
  ├─ 5. Package + upload
  │    Same as full-stack: hash-based asset diffing,
  │    multipart upload, platform provisioning
  │
  └─ 6. Live
       https://my-app.void.app
```

--------------------------------

### Install @void/md with Vue adapter

Source: https://void.cloud/guide/pages-routing/markdown

Install the @void/md package alongside the Vue adapter.

```sh
npm install @void/md @void/vue
```

--------------------------------

### Install with hidden Cloudflare management token in PowerShell

Source: https://void.cloud/guide/self-hosted-platform

PowerShell equivalent for reading the Cloudflare management API token securely and running the interactive install. Use this for domain installations when the management token is required in the shell.

```powershell
$env:CLOUDFLARE_API_TOKEN = [System.Net.NetworkCredential]::new('', (Read-Host 'Cloudflare management API token' -AsSecureString)).Password
void platform install
```

--------------------------------

### Create a new Nuxt project

Source: https://void.cloud/integrations/frameworks/nuxt

Creates a new Nuxt project and navigates into its directory. Run this first when setting up Void with Nuxt.

```bash
npm create nuxt@latest my-app
cd my-app
```

--------------------------------

### Install hono package

Source: https://void.cloud/guide/server-routing

Install hono to use built-in middleware or third-party Hono ecosystem packages.

```bash
npm install hono
```
Tokens:
Raw