vinext README

The project's README from github.com/cloudflare/vinext. As one markdown file: README.md.

vinext

Run Next.js applications on Vite, with Cloudflare Workers as the primary deployment target.

Website: vinext.dev

Read the announcement: How we rebuilt Next.js with AI in one week

Under active development. vinext supports substantial Next.js applications today, but it is not yet a drop-in replacement for every application or production workload. Expect compatibility gaps, especially in newer App Router features, and evaluate it against your own application before adopting it.

vinext reimplements the Next.js API surface on Vite rather than consuming next build output. It supports both the App Router and Pages Router, React Server Components, Server Actions, middleware, route handlers, ISR, static export, and the most commonly used next/* modules. Cloudflare Workers has the deepest integration; Node.js and other platforms are available with different levels of support.

Project status

What works today

Known gaps we're working on

These are active compatibility areas, not permanent exclusions:

Run vinext check against an existing application before migrating. If a gap is not listed here, check the open issues or file a focused reproduction.

Quick start

Use the official setup commands below. They are the recommended way to create or migrate a vinext project because they configure dependencies, scripts, Vite, and your deployment target for you.

Start a new project with create-vinext-app:

pnpm create vinext-app@latest my-app

Migrate an existing Next.js project with vinext init:

npx vinext init

Optional: migrate with an AI agent

Prefer vinext init for a direct, repeatable migration. If you want an AI agent to investigate compatibility issues and guide the migration, vinext also includes an optional Agent Skill. It works with Claude Code, OpenCode, Cursor, Codex, and dozens of other AI coding tools:

npx skills add cloudflare/vinext

Then open your Next.js project in any supported tool and say:

migrate this project to vinext

The skill handles compatibility checking, dependency installation, config generation, and dev server startup. It knows what vinext supports and will flag anything that needs manual attention.

Or do it manually

npm install vinext
npm install -D vite @vitejs/plugin-react

If you're using the App Router, also install:

npm install react-server-dom-webpack
npm install -D @vitejs/plugin-rsc

Replace next with vinext in your scripts:

{
  "scripts": {
    "dev": "vinext dev",
    "build": "vinext build",
    "start": "vinext start"
  }
}
vinext dev          # Development server with HMR
vinext build        # Production build
npx @vinext/cloudflare deploy  # Build and deploy to Cloudflare Workers

With Vite+, use vpx @vinext/cloudflare deploy, or vp exec vinext-cloudflare deploy when running the locally installed bin.

vinext auto-detects your app/ or pages/ directory, loads next.config.js, and configures Vite automatically. No vite.config.ts required for basic usage.

Your existing pages/, app/, next.config.js, and public/ directories work as-is. Run vinext check first to scan for known compatibility issues, or use vinext init to automate the full migration.

CLI reference

Command Description
vinext dev Start dev server with HMR
vinext build Production build (multi-environment for App Router: RSC + SSR + client)
vinext start Start local production server for testing
npx @vinext/cloudflare deploy Build and deploy to Cloudflare Workers
vp exec vinext-cloudflare deploy Build and deploy to Cloudflare Workers with Vite+
vinext init Migrate a Next.js project to run under vinext
vinext check Scan your Next.js app for compatibility issues before migrating
vinext lint Delegate to eslint or oxlint

Options: -p / --port <port>, -H / --hostname <host>, --turbopack (accepted, no-op).

@vinext/cloudflare deploy options: --preview, --env <name>, --name <name>, --skip-build, --dry-run, --experimental-tpr.

vinext init prompts for a deployment target, defaulting to Cloudflare. Agents must ask the user which target they want, then pass --platform=cloudflare or --platform=node.

Other options: --port <port> (default: 3001), --skip-check, --force.

If your next.config.* sets output: "standalone", vinext build emits a self-hosting bundle at dist/standalone/. Start it with:

node dist/standalone/server.js

Environment variables: PORT (default 3000), HOST (default 0.0.0.0).

Note: Next.js standalone uses HOSTNAME for the bind address, but vinext uses HOST to avoid collision with the system-set HOSTNAME variable on Linux. Update your deployment config accordingly.

Starting a new vinext project

Use create-vinext-app for new projects. It creates a TypeScript App Router project with Tailwind CSS and then runs the same vinext init setup used for existing apps:

pnpm create vinext-app@latest my-app

The generated project is Cloudflare Workers-ready by default. Pass --platform=node if you want the Node target instead.

Migrating an existing Next.js project

vinext init automates the migration in one command:

npx vinext init

This will:

  1. Run vinext check to scan for compatibility issues
  2. Install vinext runtime packages as dependencies and Vite/plugin tooling as devDependencies
  3. Rename CJS config files (e.g. postcss.config.js -> .cjs) to avoid ESM conflicts
  4. Add "type": "module" to package.json
  5. Add dev:vinext, build:vinext, and start:vinext scripts to package.json
  6. Prompt for a deployment platform (Cloudflare by default, or Node)
  7. Generate the matching vite.config.ts
  8. For Cloudflare, generate wrangler.jsonc

The migration is non-destructive -- your existing Next.js setup continues to work alongside vinext. It does not modify next.config, tsconfig.json, or any source files, and it does not remove Next.js dependencies.

vinext targets Vite 8, which defaults to Rolldown, Oxc, Lightning CSS, and a newer browser baseline. If you bring custom Vite config or plugins from an older setup, prefer oxc, optimizeDeps.rolldownOptions, and build.rolldownOptions over older esbuild and build.rollupOptions knobs, and override build.target if you still need older browsers. If a dependency breaks because of stricter CommonJS default import handling, fix the import or use legacy.inconsistentCjsInterop: true as a temporary escape hatch. See the Vite 8 migration guide.

npm run dev:vinext    # Start the vinext dev server (port 3001)
npm run build:vinext  # Build production output with vinext
npm run start:vinext  # Start vinext production server
npm run dev           # Still runs Next.js as before

Use --platform=cloudflare or --platform=node to skip the platform prompt. Cloudflare init updates an existing JavaScript or TypeScript Vite config using its AST, preserving unrelated settings. Use --force to replace an existing Node-target Vite config, or --skip-check to skip the compatibility report.

Why

Vite has become the default build tool for modern web frameworks — fast HMR, a clean plugin API, native ESM, and a growing ecosystem. With @vitejs/plugin-rsc adding React Server Components support, it's now possible to build a full RSC framework on Vite.

vinext reimplements the Next.js API surface on Vite so existing Next.js applications can run on a different toolchain. The answer, so far, is that substantial applications can.

vinext works everywhere. It natively supports Cloudflare Workers (with npx @vinext/cloudflare deploy or vp exec vinext-cloudflare deploy, bindings, KV caching), and can be deployed to Vercel, Netlify, AWS, Deno Deploy, and more via the Nitro Vite plugin. Native support for additional platforms is planned.

Alternatives worth knowing about:

Design principles

FAQ

What is this? vinext is a Vite plugin that reimplements the public Next.js API — routing, server rendering, next/* module imports, the CLI — so you can run Next.js applications on Vite instead of the Next.js compiler toolchain. It can be deployed anywhere: Cloudflare Workers is the first natively supported target, with other platforms available via Nitro. Native adapters for more platforms are planned.

Is this a fork of Next.js? No. vinext is an alternative implementation of the Next.js API surface built on Vite. The core is written from scratch. The goal is not to create a competing framework or add features beyond what Next.js offers; it is to provide the same well-defined API surface on Vite's toolchain.

Does vinext require Next.js to be installed? No. vinext ships fallback declarations for the supported next and next/* APIs, so applications can run and type-check without the next package. If both packages are installed, vinext keeps using Next.js's authoritative types and adds only its own extensions. Compatibility features that consume Next.js internals, such as styled-jsx, may still require a matching Next.js installation when used.

How is this different from OpenNext? OpenNext adapts the output of a standard next build to run on various platforms. Because it builds on Next.js's own output, it inherits broad API coverage and has been well-tested for much longer. vinext takes a different approach: it reimplements the Next.js APIs on Vite from scratch, which means faster builds and smaller bundles, but less coverage of the long tail of Next.js features. If you need a mature, well-tested way to run Next.js outside Vercel, OpenNext is the safer choice. If you want a lighter Vite-based toolchain and do not need every Next.js API, vinext may be a good fit.

Can I use this in production? You can, with caution. vinext has known compatibility gaps and has not yet been battle-tested across the full range of production Next.js workloads. Evaluate the features and deployment target your application relies on before adopting it.

Can I just self-host Next.js? Yes. Next.js supports self-hosting on Node.js servers, Docker containers, and static exports. If you're happy with the Next.js toolchain and just want to run it somewhere other than Vercel, self-hosting is the simplest path.

How are you verifying this works? The test suite has over 1,700 Vitest tests and 380 Playwright E2E tests. This includes tests ported directly from the Next.js test suite and OpenNext's Cloudflare conformance suite, covering routing, SSR, RSC, server actions, caching, metadata, middleware, streaming, and more. Vercel's App Router Playground also runs on vinext as an integration test. See the Tests section and tests/nextjs-compat/TRACKING.md for details.

Who is reviewing this code? A mix of humans and AI agents. Humans review PRs before they merge, focused on behavior, structure, and long-term direction. We lean heavily on agent-driven code review to catch issues at PR time and across the codebase. The test suite is the primary quality gate. Outside contributions and deeper human code review are very welcome.

Why Vite? Vite is an excellent build tool with a rich plugin ecosystem, first-class ESM support, and fast HMR. The @vitejs/plugin-rsc plugin adds React Server Components support with multi-environment builds. vinext builds the Next.js developer experience on top of that infrastructure.

Does this support the Pages Router, App Router, or both? Both. File-system routing, SSR, client hydration, and deployment to Cloudflare Workers work for both routers.

What version of Next.js does this target? Next.js 16.x. No support for deprecated APIs from older versions.

Can I deploy to AWS/Netlify/other platforms? Yes. Add the Nitro Vite plugin alongside vinext, and you can deploy to Vercel, Netlify, AWS Amplify, Deno Deploy, Azure, and many more. See Other platforms (via Nitro) for setup. For Cloudflare Workers, the native integration (npx @vinext/cloudflare deploy or vp exec vinext-cloudflare deploy) gives you the smoothest experience. Native adapters for more platforms are planned.

What happens when Next.js releases a new feature? We track the public Next.js API surface and add support for new stable features. Experimental or unstable Next.js features are lower priority. The plan is to add commit-level tracking of the Next.js repo so we can stay current as new versions are released.

Deployment

Cloudflare Workers

vinext has native integration with Cloudflare Workers through @cloudflare/vite-plugin, including bindings access via cloudflare:workers, KV caching, image optimization, and the @vinext/cloudflare deploy one-command workflow.

Prerequisites

Before running npx @vinext/cloudflare deploy for the first time you need to authenticate with Cloudflare and tell wrangler which account to deploy to.

Authentication — pick one:

Account ID:

wrangler needs to know which Cloudflare account to deploy to. Add your account ID to wrangler.jsonc:

{
  "account_id": "<your-account-id>",
  ...
}

Find your account ID in the Cloudflare dashboard URL (dash.cloudflare.com/<account-id>) or by running wrangler whoami after logging in.

Alternatively, set the CLOUDFLARE_ACCOUNT_ID environment variable instead of hardcoding it in the config file.

Run vinext init --platform=cloudflare first to install dependencies and create or AST-update vite.config.* and wrangler.jsonc. @vinext/cloudflare deploy then validates that setup, builds the application, and deploys to Workers without rewriting project configuration.

Cloudflare init can also configure image optimization declaratively in the Vite config with imagesOptimizer() and add the matching Wrangler Images binding. The built-in fetch handlers register that optimizer at runtime; image optimization is not implemented or generated by @vinext/cloudflare deploy.

npx @vinext/cloudflare deploy
vp exec vinext-cloudflare deploy
npx @vinext/cloudflare deploy --env staging
vp exec vinext-cloudflare deploy --env staging

Use --env <name> to target wrangler.jsonc env.<name>. --preview is shorthand for --env preview.

The init command also auto-detects and fixes common migration issues:

Both App Router and Pages Router work on Workers with full client-side hydration.

Cloudflare Bindings (D1, R2, KV, AI, etc.)

Use import { env } from "cloudflare:workers" to access bindings in any server component, route handler, or server action. No custom worker entry or special configuration required.

import { env } from "cloudflare:workers";

export default async function Page() {
  const result = await env.DB.prepare("SELECT * FROM posts").all();
  return <div>{JSON.stri

vinext (cloudflare/vinext)

Searching Database…

9.2K ·GitHub
这是做什么的?vinext 是一个 Vite 插件,它重新实现了 Next.js 的公开 API——包括路由、服务端渲染、next/ 导入和命令行工具——让 Next.js 应用可以在 Vite 上运行,而不必依赖 Next.js 官方工具链,并以 Cloudflare Workers 作为主要部署目标。
那它是 Next.js 的分叉版本吗?不是——它的核心是在 Vite 基础上从零编写的。它是对同一套明确定义的 API 的另一种实现,而不是一个想超越 Next.js 功能范围、与它竞争的新框架。
怎么上手——比如我已经有一个 Next.js 应用了呢?运行 vinext init:它会扫描兼容性问题,安装运行时依赖包,把 CJS 配置文件改名为 .cjs,添加脚本,并生成 vite.config.ts 和 wrangler.jsonc。如果想从零开始,create-vinext-app 可以搭建一个带 Tailwind 的 TypeScript App Router 项目,开箱即可部署到 Cloudflare。
我的项目里还需要安装 next 这个包吗?不需要——vinext 内置了所支持的 next 和 next/ API 的备用类型声明,所以应用不用安装 next 包也能正常运行和通过类型检查。如果两个包都装了,则优先使用 Next.js 官方的类型定义。
现在能直接用到生产环境吗?要谨慎:目前还有一些已知的功能缺口,尤其是在 Cache Components 和 Partial Prerendering 这类较新的 App Router 特性方面,而且它只支持 Next.js 16.x。先在你的应用上运行 vinext check 检查一下——核心行为有 1700 多个 Vitest 测试和 380 个 Playwright 端到端测试作保障。
它只能部署在 Cloudflare 上,还是也能在别的地方运行?Cloudflare Workers 的集成最深——支持 bindings、KV 缓存、图片优化和一条命令部署。通过 Nitro 插件还可以部署到 Vercel、Netlify、AWS、Deno Deploy 等平台,standalone Node.js 输出则会生成一个可自行托管的打包结果。
目前支持哪些 Next.js 功能?App Router 和 Pages Router 都支持,还有 React Server Components、Server Actions、路由处理程序、middleware、ISR、静态导出,以及最常用的 next/ 模块:next/link、next/image、next/navigation、next/headers、next/cache,还有 Metadata API。
它和 OpenNext 有什么不同?OpenNext 是对标准 next build 产物的适配,所以更成熟、API 覆盖更广。vinext 则是在 Vite 上重新实现这些 API,构建更快、打包更小,但牺牲了一些长尾功能的覆盖——README 也承认 OpenNext 是更稳妥、经过更多验证的选择。
迁移会不会弄坏我现有的 Next.js 环境?不会——迁移是无破坏性的。它只添加脚本和配置文件(并把 postcss.config.js 这类 CJS 文件改名为 .cjs);next.config、tsconfig.json 和源码文件都保持原样,你原来的 Next.js 环境可以和 vinext 并存继续使用。
能不能让 AI 编程助手帮我完成迁移?可以——有一个可选的 Agent Skill,能配合 Claude Code、OpenCode、Cursor、Codex 等几十种编程工具使用。它可以完成兼容性检查、依赖安装、配置生成和开发服务器启动,并标出需要人工处理的部分。
Creator
cloudflare
Size
60.8 MB
Stars
9.2K
Age
7mo
Commits · 90 Days