SHAI

shai 是一个编码助手，是您终端中的结对编程伙伴。它使用 Rust 编写，充满爱意 <3。

特性

• 交互式编码助手 - 在您的终端中与 shai 聊天，编写代码、修复错误并获取答案
• 无界面模式 - 将提示直接通过管道传递给 shai，用于脚本编写和自动化
• HTTP 服务器 - 将 shai 作为服务运行，提供与 OpenAI 兼容的 API 和 SSE 流式传输
• Shell 助手 - 当终端中的命令失败时，自动建议修复方案
• 项目上下文 - 通过 SHAI.md 文件加载项目特定信息
• MCP 支持 - 使用 MCP 和 OAuth 支持配置专用代理
• 多种 LLM 提供商 - 支持 OVHCloud、OpenAI 及其他兼容的端点

安装

最新稳定版

使用以下命令安装最新版本：

curl -fsSL https://raw.githubusercontent.com/ovh/shai/main/install.sh | sh

每日构建版

使用以下命令安装最新的 unstable 版本：

curl -fsSL https://raw.githubusercontent.com/ovh/shai/main/install.sh | SHAI_RELEASE=unstable sh

shai 二进制文件将被安装到 $HOME/.local/bin。

快速入门

默认情况下，shai 使用 OVHcloud 作为匿名用户，这意味着您会受到速率限制！如果您想使用自己的账户登录或选择其他提供商，请运行：

shai auth

设置好提供商后，您可以运行 shai：

shai

使用方法

交互模式

只需运行 shai 即可启动交互式编码助手。您可以与 shai 对话，它会帮助您编写代码、修复错误并解答问题。

无界面模式

shai 也可以在无界面模式下运行。在这种情况下，只需将提示通过管道传递给 shai，它会将事件流输出到标准错误：

echo "帮我用 main.py 写一个 Hello World" | shai

您还可以指示 shai 在完成任务后返回整个对话记录：

echo "帮我用 main.py 写一个 Hello World" | shai 2>/dev/null --trace

这非常方便，因为您可以将多个 shai 调用串联起来：

echo "帮我用 main.py 写一个 Hello World" | shai --trace | shai "现在运行它！"

HTTP 服务器模式

您可以将 shai 作为支持 SSE 流式传输的 HTTP 服务运行。此模式提供了多个 API 端点：

shai serve --port 3000

可用的 API 端点：

• POST /v1/chat/completions - OpenAI Chat Completions API（临时模式）
• POST /v1/responses - OpenAI Responses API（有状态/无状态）
• GET /v1/responses/{id} - 根据 ID 获取响应
• POST /v1/responses/{id}/cancel - 取消响应
• POST /v1/multimodal - 简单的多模态 API（流式）
• POST /v1/multimodal/{session_id} - 简单的多模态 API（带会话）

选项：

• --port <PORT> - 绑定的端口（默认：3000）
• --ephemeral - 使用临时模式（每个请求生成新的代理）
• [AGENT] - 用于持久化会话的代理名称

Shell 助手

当命令执行失败时，shai 还可以充当 Shell 助手，并为您提供修复建议。它通过注入命令钩子并监控您的终端输出来实现这一点。您最后的终端输出以及最后一条命令和错误代码会被发送到 LLM 提供商进行分析。

要开始让 shai 监控您的 Shell，只需输入：

shai on

例如：

要停止 shai 监控您的 Shell，您可以输入：

shai off

配置

项目上下文文件

您可以在项目的根目录下创建一个 SHAI.md 文件，其中包含您希望 shai 了解的关于该项目的所有信息（架构、构建步骤、重要目录等）。shai 会自动加载该文件作为额外的上下文。

自定义代理（使用 MCP）

您可以不使用单一的全局配置，而是创建一个单独的自定义配置文件。

.ovh.config 包含了一个使用远程 MCP 服务器配置的自定义配置示例。

将此文件放置在 ~/.config/shai/agents/ovh.config 中，然后您可以列出可用的代理：

curl https://raw.githubusercontent.com/ovh/shai/refs/heads/main/.ovh.config -o ~/.config/shai/agents/ovh.config
shai agent list

您可以使用 agent 子命令运行特定代理的 shai：

shai agent ovh

OVHCloud 端点

OVHCloud 提供了兼容的 LLM 端点，可用于将 shai 与工具结合使用。首先在您的 OVHCloud 账户中创建一个 公共云 项目，然后前往 AI 端点 并获取您的 API 密钥。将其设置到 shai 后，您可以：

• 选择具有函数调用功能的模型之一（例如 gpt-oss-120b、gpt-oss-20b、Mistral-​Small-​3.2-​24B-​Instruct-​2506），以获得最佳性能；
• 选择任何其他模型，并强制使用结构化输出（/set so 选项）。

开发

构建项目

只需使用 cargo 构建项目即可：

git clone git@github.com:ovh/shai.git
cd shai
cargo build --release

SHAI 快速上手指南

SHAI 是一款运行在终端中的智能编程助手（Coding Agent），由 Rust 编写。它能与你对话以编写代码、修复漏洞，支持无头模式进行自动化脚本处理，并可作为 HTTP 服务运行。

环境准备

• 操作系统：Linux 或 macOS（Windows 需通过 WSL 使用）
• 前置依赖：
  • curl：用于下载安装脚本
  • bash 或兼容的 Shell 环境
• 网络要求：需能访问 GitHub 及 LLM 提供商接口（如 OVHCloud、OpenAI 等）

注意：默认情况下 SHAI 以匿名用户使用 OVHCloud 服务，会有速率限制。建议配置个人 API Key 以获得更好体验。

安装步骤

1. 安装稳定版

执行以下命令一键安装最新稳定版本：

curl -fsSL https://raw.githubusercontent.com/ovh/shai/main/install.sh | sh

安装完成后，二进制文件位于 $HOME/.local/bin，请确保该目录已加入你的 PATH 环境变量。

2. 安装夜间测试版（可选）

如需体验最新功能（可能不稳定），可安装 unstable 版本：

curl -fsSL https://raw.githubusercontent.com/ovh/shai/main/install.sh | SHAI_RELEASE=unstable sh

基本使用

1. 配置认证（推荐）

首次使用前，建议运行以下命令登录账户或选择其他 LLM 提供商，以避免匿名用户的速率限制：

shai auth

按照提示完成认证流程。

2. 交互式模式

直接运行 shai 进入交互界面，即可开始与 AI 结对编程：

shai

你可以输入自然语言指令，例如：“帮我写一个 Python 的 Hello World"，SHAI 将生成代码并解释。

3. 无头模式（脚本化）

你也可以将提示词通过管道传递给 SHAI，适用于自动化脚本：

echo "make me a hello world in main.py" | shai

若需要获取完整的对话追踪记录以便串联调用：

echo "make me a hello world in main.py" | shai --trace

4. 开启 Shell 辅助（可选）

让 SHAI 监控你的终端，当命令报错时自动提供修复建议：

shai on

关闭监控：

shai off