Zephyr Cloud Docs

    TanStack Start

    If you created your app with the TanStack Start CLI and selected the Cloudflare deployment option, deploying to Zephyr is just adding the Zephyr TanStack Start plugin to your Vite build.

    For the upstream CLI flow, see TanStack’s docs: TanStack Start (React) Quick Start.

    For Cloudflare-specific setup details (Wrangler config, Cloudflare Vite plugin, etc.), see: Cloudflare Workers: TanStack Start.

    Prerequisites
    • Finished our Prerequisites setup guide
    • Your organization is using Zephyr’s managed Cloudflare integration (the default integration)

    Install

    Add the plugin to your project:

    npm
    yarn
    pnpm
    bun
    deno
    npm add -D vite-plugin-tanstack-start-zephyr

    Configure Vite

    In your vite.config.ts, import withZephyrTanstackStart and add it to the end of your plugins array (after TanStack Start):

    import { withZephyrTanstackStart } from 'vite-plugin-tanstack-start-zephyr';

export default defineConfig({
  plugins: [
    // ...your existing plugins (cloudflare(), tanstackStart(), react(), etc.)
    withZephyrTanstackStart(),
  ],
});
    Git is required

    Zephyr derives your Application UID from your package.json and git context. Make sure your repo is initialized and has a remote (for example, GitHub).

    Deploy

    Run your production build:

    npm run build

    On the first run, you’ll be prompted to authenticate:

    Info

    The first time you initiate a build with Zephyr, it will prompt you to log in by directing you to the Zephyr website. This login is required only on your first build; subsequent builds will not require a login.

    We may require you to log in again if you removed your Zephyr configuration file ~/.zephyr locally.

    SSR Worker (beta)

    TanStack Start deployments on Zephyr use our SSR Worker runtime.

    • This is currently beta and only available on Cloudflare
    • It is only available on Zephyr’s default (managed) Cloudflare integration
    • It is not available on Bring Your Own Cloud (BYOC) deployments

    Learn more: SSR Worker (beta).