CoolkHz/muse-protocol-go

选用指南

AI 根据 README 整理 · 2026/10/31 09:11:50

使用方式

可作为 Go 模块导入使用，也提供命令行示例程序。

查看 README 依据

### 作为 Go 模块使用 ```sh go get github.com/CoolkHz/muse-protocol-go ``` ## SDK 接入 ### 1. 获取登录会话 选择一种认证方式，成功后统一获得 `login.Result`，供后续协议调用使用。 **密码登录** ```go result, err := login.Login(ctx, login.Options{ Email: email, Password: password, // 由调用方提供，保留原始内容及首尾空格 Proxy: "direct", }) if err != nil { return err } ``` **验证码登录** ```go result, err := login.Login(ctx, login.Options{ Email: email, GetOTP: func(ctx context.Context, sentAt time.Time) (string, error) { // 在你的 UI、终端或业务系统中实现 waitForUserCode。 // sentAt 标记本次发码；等待过程应响应 ctx 取消。

**首次接入的路径：** 登录取得会话 Cookie → 查询并唤醒 VM → 申请临时令牌 → 建立 Noise 通道 → 提交 `/chat/stream` → 读取 `/chat/history` → 返回文本增量或下载媒体。 文本增量来自会话历史的持续读取，流事件用于唤醒轮询。工作区媒体沿同一网关通道下载；上游返回的外部媒体 URL 也可作为下载来源，文件保存到 `DataDir/media`。握手细节、protobuf 字段与接口顺序见 [协议说明](docs/protocol.md)。 ## 快速开始 需要 **Go 1.24+** 和可用的 Muse 账号。 ### 直接运行示例 ```sh git clone https://github.com/CoolkHz/muse-protocol-go.git cd muse-protocol-go go build -o bin/muse-protocol ./cmd/muse-protocol export MUSE_EMAIL='user@example.com' export MUSE_PROXY=direct # 请求发码后，在终端输入你自行获取的验证码。 ./bin/muse-protocol --auth otp --mode chat --prompt '你好' ```

部署要求

需要 Go 1.24+ 和可用的 Muse 账号。

查看 README 依据

**首次接入的路径：** 登录取得会话 Cookie → 查询并唤醒 VM → 申请临时令牌 → 建立 Noise 通道 → 提交 `/chat/stream` → 读取 `/chat/history` → 返回文本增量或下载媒体。 文本增量来自会话历史的持续读取，流事件用于唤醒轮询。工作区媒体沿同一网关通道下载；上游返回的外部媒体 URL 也可作为下载来源，文件保存到 `DataDir/media`。握手细节、protobuf 字段与接口顺序见 [协议说明](docs/protocol.md)。 ## 快速开始 需要 **Go 1.24+** 和可用的 Muse 账号。 ### 直接运行示例 ```sh git clone https://github.com/CoolkHz/muse-protocol-go.git cd muse-protocol-go go build -o bin/muse-protocol ./cmd/muse-protocol export MUSE_EMAIL='user@example.com' export MUSE_PROXY=direct # 请求发码后，在终端输入你自行获取的验证码。 ./bin/muse-protocol --auth otp --mode chat --prompt '你好' ```

已知限制

非官方协议实现，需要已有可用账号；不支持需要 RV 密钥认证的机密 VM；每次 Chat 使用独立会话，多轮上下文需调用方组织。

查看 README 依据

[GitHub Actions](https://github.com/CoolkHz/muse-protocol-go/actions/workflows/ci.yml) 对每次 push / pull request 执行格式、静态检查、竞态测试和编译。验证范围为本地模拟服务与公开测试向量；真实上游可用性取决于账号、网络及协议版本。 ## 接入边界 - **非官方协议实现。** 需要已有可用账号；上游登录状态、验证要求及接口变化可能影响可用性。遇到额外验证时会停止并返回错误。 - **作为 SDK 嵌入服务。** 仓库提供协议方法和示例；OpenAI / Anthropic HTTP 兼容层、账号池、额度管理与任务持久化由上层实现。 - **每次 Chat 使用独立会话。** 多轮上下文由调用方组织到 prompt 中；取消本地等待不代表上游生成或计费一定停止。 - **以实际媒体结果为准。** 输出张数可能少于 `N`，尺寸与时长由上游决定；下载失败不会自动重新生成。 - **支持标准 VM 流程。** 当前不支持需要 RV 密钥认证的机密 VM，也不提供硬件远程证明验证。 ## 文档与贡献 - [协议说明](docs/protocol.md)：认证、HTTPS 引导、Noise 握手、protobuf 字段、历史轮询和媒体下载。