opennextjs-CLI

用于为Cloudflare Workers设置和配置OpenNext.js项目的交互式CLI/TUI工具（AWS+Netlify即将推出）

______________________________________________________________________

概述

OpenNext.js命令行界面 是一个全面的交互式命令行工具，简化了Cloudflare Workers的OpenNext.js项目的设置和管理。基于现代用户体验原则构建，使用 @clack/prompts （与 next-forge)，它为项目设置、配置、部署和维护提供了一个美观、直观的界面。

什么是OpenNext.js？

OpenNext.js 是一个开源适配器，可以将Next.js应用程序部署到各种平台，包括Cloudflare Workers。此CLI工具自动化了整个设置和配置过程，使其像 create-next-app.

包裹

此monorepo包含 2个npm包 它们共享同一个GitHub存储库，但分别发布：

1. @jsonbored/opennextjs-cli -CLI工具

用于设置和管理OpenNext.js项目的主命令行界面。

安装：

npm install -g @jsonbored/opennextjs-cli
# or
pnpm add -g @jsonbored/opennextjs-cli

别名： onjs （较短的命令）

文档： 看 获取完整的CLI文档。

2. @jsonbored/opennextjs-mcp -MCP服务器

模型上下文协议服务器，使AI工具能够与OpenNext.js项目交互。

安装：

npm install -g @jsonbored/opennextjs-mcp

文档： 看 获取完整的MCP文档。

注： 运行时，MCP服务器会自动配置 opennextjs-cli mcp setup.

快速开始

安装CLI

npm install -g @jsonbored/opennextjs-cli
# or use the alias
onjs --version

创建一个新项目

opennextjs-cli init my-project
# or
onjs init my-project

添加到现有项目

cd your-existing-nextjs-project
opennextjs-cli add
# or
onjs add

部署

pnpm deploy
# or
npm run deploy

发展

先决条件

• Node.js 18.0.0或更高
• pnpm 8.0.0或更高版本（推荐）
• Git （用于版本控制）

设置

# Clone repository
git clone https://github.com/JSONbored/opennextjs-cli.git
cd opennextjs-cli

# Install dependencies
pnpm install

# Build all packages
pnpm build

# Run tests
pnpm test

开发流程

# Watch mode for CLI package
cd packages/opennextjs-cli
pnpm dev

# Watch mode for MCP package
cd packages/opennextjs-mcp
pnpm dev

# Run CLI locally
cd packages/opennextjs-cli
pnpm dev
# Then use: node dist/index.js 

测试

# Run all tests
pnpm test

# Run CLI tests
cd packages/opennextjs-cli
pnpm test

# Run MCP tests
cd packages/opennextjs-mcp
pnpm test

# Run with coverage
pnpm test:coverage

代码检查

# Lint all packages
pnpm lint

# Lint specific package
cd packages/opennextjs-cli
pnpm lint

特性

核心功能

• 交互式安装向导 -漂亮的分步配置提示
• 自动配置 -生成 open-next.config.ts, wrangler.toml，以及更多
• 智能默认值 -内置合理默认值的最佳实践
• 依赖管理 -自动安装所需的软件包
• 类型安全 -通过Zod验证完全支持TypeScript
• 现代TUI -使用美观的终端UI @clack/prompts

安全性和可靠性

• 安全检查 -全面的操作前验证
• 自动回滚 -失败时恢复更改
• 自动备份 -在修改之前备份文件
• Monorepo支持 -检测和处理monorepo结构
• 路径验证 -防止不安全的文件操作

AI集成

• MCP服务器 -用于AI工具集成的模型上下文协议服务器
• 光标/克劳德桌面 -与AI编码助手无缝集成
• 项目见解 -AI可以查询项目状态、验证配置等

CLI命令

CLI提供了15个命令来完成项目管理：

项目设置

• init -使用OpenNext.js创建新的Next.js项目
• add -将OpenNext.js添加到现有项目中
• config -更新配置

项目管理

• status -显示项目状态
• validate -验证配置
• doctor -具有自动修复功能的健康检查
• setup -配置CLI设置

部署与开发

• deploy -部署到Cloudflare
• preview -启动本地预览服务器
• update -更新依赖关系

环境与Cloudflare

• env -管理环境变量
• cloudflare -管理Cloudflare身份验证

高级

• migrate -从Vercel/Netlify迁移
• mcp -设置MCP服务器
• completion -Shell完成脚本

完整文档： 看

MCP服务器

MCP服务器为AI工具提供了对OpenNext.js项目的编程访问：

工具（7）

• get_project_status -获取项目信息
• validate_configuration -验证设置
• check_health -健康检查
• list_environments -列出Cloudflare环境
• deploy_to_cloudflare -部署项目
• start_preview_server -开始预览
• update_configuration -更新配置

资源（4）

• opennextjs://config/wrangler.toml -牧马人配置
• opennextjs://config/open-next.config.ts -OpenNext配置
• opennextjs://config/package.json -软件包配置
• opennextjs://project/structure -项目结构

提示（3）

• setup-opennextjs-project -安装指南
• troubleshoot-deployment -故障排除
• optimize-cloudflare-config -优化提示

完整文档： 看

需求

• Node.js 18.0.0或更高
• pnpm 8.0.0+（推荐）或npm/纱线/面包
• Cloudflare帐户 （用于部署）
• 牧马人CLI （自动安装）

缓存策略

CLI支持多种缓存策略：

路线图

完整的：

• ✅ 阶段1：核心CLI命令（init、add、config、status、validate）
• ✅ 第二阶段：高级命令（部署、预览、更新、环境、云耀斑、医生）
• ✅ 阶段5:MCP服务器（工具、资源、提示）

马上就来：

• 阶段3：模板、迁移助手、模拟运行模式、配置导出/导入
• 第4阶段：CI/CD集成、测试设置、监控设置

贡献

欢迎投稿！请参阅我们的投稿指南（即将发布）。

开发设置

# Clone repository
git clone https://github.com/JSONbored/opennextjs-cli.git
cd opennextjs-cli

# Install dependencies
pnpm install

# Build packages
pnpm build

# Run tests
pnpm test

# Run CLI locally
cd packages/opennextjs-cli
pnpm dev

相关项目

• OpenNext.js -使这成为可能的核心适配器
• OpenNext.js Cloudflare -Cloudflare特定实施
• Cloudflare员工 -部署平台
• 模型上下文协议 -MCP规范

支持

• 文档
• 报告问题
• 讨论

学分

此工具是为以下对象构建的，并由其提供动力 OpenNext.js，一个令人惊叹的项目，使将Next.js部署到各种平台成为可能。

• OpenNext.js Cloudflare: https://github.com/opennextjs/opennextjs-cloudflare
• 官方文件: https://opennext.js.org/cloudflare
• 包裹: @opennextjs/cloudflare 在npm上

______________________________________________________________________

明星历史

______________________________________________________________________

由...制作💜 通过 JSON无聊

• • • 🐛 报告问题