diff --git a/docs/integrations/Development-Tools/Codex.md b/docs/integrations/Development-Tools/Codex.md new file mode 100644 index 0000000000000000000000000000000000000000..ecfc2dff77a4c9aa616b2a2a1313ba1d8c75c1c8 --- /dev/null +++ b/docs/integrations/Development-Tools/Codex.md @@ -0,0 +1,157 @@ +--- +sidebar_position: 8 +--- + +# Codex + +Codex 是一款基于 OpenAI API 的 AI 编程助手工具。跟着这个教程,你可以轻松在自己的电脑上安装并使用 Codex。 + +:::tip +模力方舟提供对 Codex 的原生支持,你可以使用模力方舟的任一编码模型,享受更优质的中文支持和更低的调用成本。 +::: + +## 1. 安装 Codex + +你可以使用你喜欢的包管理器安装 Codex CLI: + +### 使用 npm 安装(推荐) + +```bash +npm install -g @openai/codex +``` + +### 使用 Homebrew 安装(macOS) + +```bash +brew install codex +``` + +### 验证安装是否成功 + +安装完成后,打开终端,输入以下命令: + +```bash +codex --version +``` + +如果显示版本号,说明安装成功了! + +## 2. 获取访问令牌 + +开发者首先需要访问 [**工作台->设置->访问令牌**]({{SITE_URL}}/dashboard/settings/tokens) 中获取访问令牌,没有购买 Serverless API 的开发者,可以使用免费体验访问令牌(仅供体验,每日调用次数有限),复制想要使用的令牌即可。 + +![](/img/serverless-api/integrated/integrate14.png) + +## 3. 配置 Codex + +为了让 Codex 连接到模力方舟的服务,需要进行配置文件设置和环境变量配置。 + +### 配置文件设置 + +在 `~/.codex/config.toml` 文件中添加以下配置: + +```toml +model_provider = "moark" +model = "GLM-4_5" +model_reasoning_effort = "high" +disable_response_storage = true +preferred_auth_method = "apikey" + +[model_providers.moark] +name = "moark" +base_url = "{{SITE_URL}}/v1" +wire_api = "chat" +requires_openai_auth = true +env_key = "GITEE_AI_KEY" +``` + +在 `~/.codex/auth.json` 文件中配置 API 密钥: + +```json +{ + "OPENAI_API_KEY": null +} +``` +:::tip +将 `OPENAI_API_KEY` 设置为 `null`,然后设置环境变量 `GITEE_AI_KEY` 为您的 API 密钥。 +::: + +## 4. 配置环境变量 + +### Windows (PowerShell) + +**临时设置(当前会话)** + +```powershell +$env:GITEE_AI_KEY = "你的API密钥" +``` + +**永久设置(用户级)** + +```powershell +# 设置用户级环境变量(永久生效) +[System.Environment]::SetEnvironmentVariable("GITEE_AI_KEY", "你的API密钥", [System.EnvironmentVariableTarget]::User) +``` + +### macOS / Linux / WSL2 + +**临时设置(当前会话)** + +```bash +export GITEE_AI_KEY="你的API密钥" +``` + +**永久设置** + +将以下内容添加到您的 shell 配置文件中: + +```bash +# 对于 zsh(macOS 默认) +echo "export GITEE_AI_KEY=你的API密钥" >> ~/.zshrc +source ~/.zshrc + +# 对于 bash +echo "export GITEE_AI_KEY=你的API密钥" >> ~/.bash_profile +source ~/.bash_profile +``` + +**重要提示**:记得将 "你的API密钥" 替换为在上方 "获取访问令牌" 步骤中获取的实际密钥。 + +### 验证环境变量设置 + +**Windows (PowerShell)** + +```powershell +echo $env:GITEE_AI_KEY +``` + +**macOS / Linux / WSL2** + +```bash +echo $GITEE_AI_KEY +``` + +预期输出示例: + +``` +你的API密钥 +``` + +:::tip +如果输出为空或显示变量名本身,说明环境变量设置失败,请重新设置。设置后需要重新打开终端窗口才能生效。 +::: + +## 5. 开始使用 Codex + +配置完成后,你就可以开始使用 Codex 了!在任何目录下运行: + +```bash +codex +``` + +这将启动 Codex 交互界面,你可以开始与 AI 编程助手进行对话了。 + +### 更多资源 + +- [平台 API 文档](/docs/openapi/v1) +- [Codex 官方文档](https://developers.openai.com/codex/cli) \ No newline at end of file diff --git a/docs/integrations/Development-Tools/claude-code.md b/docs/integrations/Development-Tools/claude-code.md index 7f13e9abace74da0ef4a6a6207efb99df7485dd8..ac4f7aea57acc20faf548a743bf9966c5e4956b9 100644 --- a/docs/integrations/Development-Tools/claude-code.md +++ b/docs/integrations/Development-Tools/claude-code.md @@ -217,7 +217,9 @@ GLM-4_5 GLM-4_5 ``` -💡 如果输出为空或显示变量名本身,说明环境变量设置失败,请重新设置。设置后需要重新打开终端窗口才能生效。 +:::tip +如果输出为空或显示变量名本身,说明环境变量设置失败,请重新设置。设置后需要重新打开终端窗口才能生效。 +::: ## 5. 开始使用 Claude Code