WindsurfAPI

环境要求

• Node.js 运行环境（用于执行 node src/index.js）
• Git（用于克隆仓库）
• Docker 与 Docker Compose（仅选择 Docker 部署时需要）
• PM2（可选，用于常驻后台运行）

安装与启动步骤

1. 1克隆项目仓库

   把 WindsurfAPI 源码下载到本地，并进入项目目录，后续命令都在此目录执行。

   git clone https://github.com/dwgx/WindsurfAPI.git
   cd WindsurfAPI

   复制

2. 2运行一键初始化

   执行 setup.sh，自动建目录、配权限并生成 .env 配置文件，这是官方的推荐入口。

   bash setup.sh

   复制

3. 3启动服务

   用 node 直接拉起主程序，服务会在前台运行，日志直接输出到当前终端。

   node src/index.js

   复制

4. 4打开 Dashboard

   浏览器访问 Dashboard 地址确认服务已起来，把“你的IP”换成实际机器 IP 或 localhost。

5. 5改用 Docker 部署

   不想装 Node 环境时用这条路线：先复制环境变量模板，再后台构建启动并跟踪日志。

   cp .env.example .env
   docker compose up -d --build
   docker compose logs -f

   复制

6. 6用 PM2 常驻运行

   需要长期后台运行时用 PM2 托管，并保存进程列表、设置开机自启。

   npm install -g pm2
   pm2 start src/index.js --name windsurf-api
   pm2 save && pm2 startup

   复制

关键配置

如何确认成功

浏览器打开 http://你的IP:3003/dashboard，能看到 Dashboard 页面即表示启动成功。

常见问题

注意事项

• 用 PM2 部署时请勿执行 pm2 restart，更新请用 bash update.sh。
• Docker 部署前需先执行 cp .env.example .env 生成配置文件。
• 手动部署 macOS 时，使用 install-ls.sh 打印出的 LS_BINARY_PATH。
• 只有关掉 DEVIN_CONNECT、走 Cascade 时，才会在缺二进制时尝试安装 LS。