CodeRider CLI 使用指南

1. 初识 CodeRider CLI#

CodeRider CLI 旨在让开发者基于命令行界面完成复杂的 AI 辅助任务，不局限于某个特定的 IDE。启动进入 CodeRider 窗口后，您将看到如下初始化界面：

1.1 界面功能分区#

1.2 快捷交互指令#

为了提升操作效率，界面集成了以下快捷键引导：

• Tab(agents): 快速切换或选择不同的角色以应对特定场景，包含 Build 与 Plan。
• Ctrl + P (commands): 呼出全局命令面板，执行系统配置。

1.3 初始化配置指引 (Tip)#

在首次使用时，您会看到如下建议：

text
复制
Tip: 运行 /connect 以添加超过 75 家主流 LLM 提供商的 API Key。

CodeRider 支持私有化部署与 SaaS 方案：

• 私有化：您可以使用企业管理员配置的企业内部指定模型，保障您数据的安全性。
• SaaS：您可以根据安全需求选择接入 JiHu GitLab 内置模型或自定义国内 SOTA 模型（如 Zhipu AI, Qwen, MiniMax 等）。

2. 模型配置#

2.1 官方模型#

CodeRider 官方提供国内多种 SOTA 模型，用户可通过 /models 切换模型。

对于 SaaS 用户，当您首次与 CodeRider 进行对话时，系统将开始记录您使用官方模型的调用量。我们赋予免费用户限量的 Token，您可以在当前使用环境中通过/teams选择群组，并在所选群组中通过/cost查询 Token 余额。

若您希望充值以获取更多的 Token 使用额度，请在查询余额界面单击“Recharge”跳转充值。

2.2 用户配置模型#

通过 CodeRider，用户可配置 API 密钥来使用任意大模型提供商。用户通过 /connect命令，可查看所有可连接供应商。选择供应商后，根据提示填入 API 密钥及其他必要参数即可使用配置模型。

3. 初始化#

1. 配置好模型后，导航到目标项目目录

text
复制
cd /path/to/project

2. 在目标路径下运行 CodeRider

text
复制
coderider

3. 运行以下命令为项目初始化 CodeRider

text
复制
/init

CodeRider 会分析当前项目并在项目根目录创建一个AGENTS.md文件。

这有助于 CodeRider 理解项目结构和编码规范。

4. 使用 CodeRider#

当用户第一次使用 CodeRider CLI 时，以下示例会有所帮助。

提问#

当用户遇到不熟悉的代码时，可以使用 CodeRider 讲解代码库。

text
复制
帮我快速介绍这个文件 @src/App.tsx 

实现需求#

• 制定计划

  在使用 CodeRider 实现需求前，可以先使用Plan模式制定一个计划。

  CodeRider 在“计划”模式下不会进行任何修改，而是建议如何实现需求。

  使用Tab键切换到“计划”模式，您会在左下角看到当前模式。

  

  接下来，描述具体需求。在描述需求过程中请尽量提供足够的细节帮助 CodeRider 精确理解，如果需要可以提供必要的上下文和示例。

  提示：将图片拖放到终端中即可将其添加到提示词中。

• 迭代计划

  当 CodeRider 给出计划后，用户可以提供反馈或补充更多细节。

• 实现需求

  当你对计划满意后，再次按 Tab 键切换回构建模式。

  接着，CodeRider 将按照计划实现所述需求。

5. 常用指令#

TUI 指令#

CLI 指令#

6. 编辑器配置#

/editor 和 /export 命令都使用 EDITOR 环境变量中指定的编辑器。

• Linux / macOS

text
复制
1    # Example for nano or vim
2    export EDITOR=nano
3    export EDITOR=vim
4
5    # For GUI editors, VS Code, Cursor, VSCodium, Windsurf, Zed, etc.
6    # include --wait
7    export EDITOR="code --wait"

要使其永久生效，请将其添加到您的 shell 配置文件中； ~/.bashrc、~/.zshrc 等。

• Windows（CMD）

  text
  复制
  set EDITOR=notepad
  
  # For GUI editors, VS Code, Cursor, VSCodium, Windsurf, Zed, etc.
  # include --wait
  set EDITOR=code --wait

  要使其永久生效，请使用系统属性 > 环境变量。

• Windows（PowerShell）

  text
  复制
  $env:EDITOR = "notepad"
  
  # For GUI editors, VS Code, Cursor, VSCodium, Windsurf, Zed, etc.
  # include --wait
  $env:EDITOR = "code --wait"

  要使其永久生效，请将其添加到您的 PowerShell 配置文件中。

常用的编辑器选项包括：

• code - Visual Studio Code
• cursor - Cursor
• windsurf - Windsurf
• nvim - Neovim 编辑器
• vim - Vim 编辑器
• nano - Nano 编辑器
• notepad - Notepad（Windows 记事本）
• subl - Sublime Text

某些编辑器需要命令行参数才能以阻塞模式运行。--wait 标志使编辑器进程阻塞直到关闭。