@priders/cwindsurf 0.1.0

package/README.md

@@ -0,0 +1,64 @@
+# Windsurf++ / cwindsurf
+
+让 Windsurf/Devin 使用你自己的模型、API Key 和本地推理服务，并直接在 Cascade 模型选择器中切换。
+
+## 功能特点
+
+- 支持 OpenAI Chat Completions、OpenAI Responses、Anthropic Messages 和 Google Gemini API。
+- 可连接 Ollama、LM Studio、vLLM、llama.cpp 及常见云端模型服务。
+- 支持流式文本、reasoning/thinking、工具调用和工具结果续写。
+- 在 Windsurf++ 侧边栏管理 Provider、模型、连接测试、模型拉取和导入导出。
+- 提供 BYOK/官方流量的 RPM、TPM、Token、费用、延迟、错误、趋势、模型对比和预算统计。
+- 支持从 models.dev、LiteLLM 和 OpenRouter 同步模型价格。
+- 支持按 Provider、模型和语言配置本地 Commit 信息生成。
+- 支持 LinuxDO/GitHub 登录、设备授权、远程吊销和签名离线租约。
+- 支持 macOS、Windows 和 Linux。
+
+## 安装
+
+需要 Node.js 18 或更高版本：
+
+```bash
+npm install -g @priders/cwindsurf
+cwindsurf install
+```
+
+完全退出并重新打开 Windsurf/Devin，然后打开 **Windsurf++** 侧边栏：
+
+1. 使用 LinuxDO 或 GitHub 登录当前设备。
+2. 新增 Provider，填写地址、API Key 和模型。
+3. 测试连接并开启 BYOK。
+4. 从 Cascade 模型选择器中选择自定义模型。
+
+如果应用安装在非标准位置，可在安装前设置 `CWINDSURF_APP_PATH`，其值可以是应用目录或可执行文件路径。
+
+- Windows 系统级安装可能需要管理员终端。
+- Linux 系统目录安装可能需要 `sudo --preserve-env=HOME $(command -v cwindsurf) install`。
+- Linux 证书信任支持 Debian/Ubuntu `update-ca-certificates` 和 Fedora/RHEL `update-ca-trust`。
+
+## 命令
+
+```text
+cwindsurf install      安装 Windsurf++
+cwindsurf status       查看安装状态
+cwindsurf uninstall    完整卸载并清理本地数据
+cwindsurf help         查看帮助
+```
+
+## 本地数据与安全
+
+- Provider 配置和 API Key 保存在本机 `~/.cwindsurf/`，Unix 系统使用当前用户权限。
+- Refresh Token 和设备私钥保存在编辑器的 SecretStorage，不会写入普通配置文件。
+- 统计默认不保存 prompt 和响应正文；开发抓包能力不包含在公开构建中。
+- 公开构建移除源码映射和开发工具，产物经过 bundle、压缩、混淆、Ed25519 签名和哈希校验。
+- 客户端 JavaScript 仍可能被逆向，请勿把任何服务端秘密写入客户端。
+
+## 卸载注意
+
+`cwindsurf uninstall` 会删除补丁、证书、扩展、缓存和整个 `~/.cwindsurf/` 目录。需要保留 Provider/API Key 或统计数据时，请在卸载前自行备份。
+
+## 兼容性与责任边界
+
+本项目不是 Windsurf、Devin、Codeium 或模型厂商的官方产品。安装过程会修改第三方应用文件，应用升级后可能需要重新安装，也可能受相关服务条款影响。仅在你有权使用的设备、账号和 API 上安装，不得用于绕过计费、访问控制或服务限制。
+
+当前发布包标记为 `UNLICENSED`。