简介

开始使用 OpenCtrlC。

OpenCtrlC 是一个专注于终端工作流和本地开发的开源 AI 编码代理。

让我们开始吧。

要在终端中使用 OpenCtrlC，你需要：

一款现代终端模拟器，例如：
- WezTerm，跨平台
- Alacritty，跨平台
- Ghostty，Linux 和 macOS
- Kitty，Linux 和 macOS
你想使用的 LLM 提供商的 API 密钥。

安装

安装 OpenCtrlC 最简单的方法是通过安装脚本。

curl -fsSL https://raw.githubusercontent.com/ponponon/openctrlc/dev/install | bash

也可以通过 npm 全局安装 CLI（需要 Node.js 和 npm）：

npm install -g openctrlc

如果之前安装的是旧包名，请先运行 npm uninstall -g openctrlc-ai，再安装 openctrlc。

macOS 和 Linux 用户也可以通过 OpenCtrlC 项目的 Homebrew tap 安装：

brew install ponponon/tap/openctrlc

针对不同平台，可以从官网软件下载页下载最新安装包；稳定版在可用时优先使用 R2 镜像，失败时自动回退到 GitHub Releases。

通过 OpenCtrlC，你可以配置 API 密钥来使用受支持的 LLM 提供商。 OpenCtrlC 不提供托管模型服务，你可以自行选择提供商和计费方式。

你可以随时更换提供商。查看提供商目录。

配置好提供商后，导航到你想要处理的项目目录。

cd /path/to/project

然后运行 OpenCtrlC。

openctrlc

接下来，运行以下命令为项目初始化 OpenCtrlC。

/init

OpenCtrlC 会分析你的项目并在项目根目录创建一个 AGENTS.md 文件。

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

现在你已经准备好使用 OpenCtrlC 来处理项目了，尽管提问吧！

如果你是第一次使用 AI 编码代理，以下示例可能会对你有所帮助。

你可以让 OpenCtrlC 为你讲解代码库。

@src/auth/session.ts 中的身份验证流程是如何工作的？

当你遇到不熟悉的代码时，这个功能非常有用。

你可以让 OpenCtrlC 为项目添加新功能。不过我们建议先让它制定一个计划。

制定计划

OpenCtrlC 有一个计划模式，该模式下它不会进行任何修改，而是建议如何实现该功能。

使用 Tab 键切换到计划模式。你会在右下角看到模式指示器。
```
<TAB>
```
接下来描述你希望它做什么。
```
用户登录后，我们希望为会话记录一条诊断事件。
请先追踪现有的身份验证流程，再提出保持当前会话行为的最小实现方案。
```
你需要提供足够的细节，让 OpenCtrlC 理解你的需求。可以把它当作团队中的一名初级开发者来沟通。

为 OpenCtrlC 提供充足的上下文和示例，帮助它理解你的需求。
迭代计划

当它给出计划后，你可以提供反馈或补充更多细节。
```
我们希望参考附带的设计稿改进账户页面。
[Image #1] 请保留现有导航和响应式行为。
```
将图片拖放到终端中即可将其添加到提示词中。

OpenCtrlC 可以扫描你提供的图片并将其添加到提示词中。只需将图片拖放到终端窗口即可。
构建功能

当你对计划满意后，再次按 Tab 键切换回构建模式。
```
<TAB>
```
然后让它开始实施。
```
Sounds good! Go ahead and make the changes.
```

对于比较简单的修改，你可以直接让 OpenCtrlC 实施，无需先审查计划。

请追踪登录用户如何进入 session API，说明身份验证与会话创建之间的边界，
并提出一个不重复实现请求处理的聚焦改动。

请确保提供足够的细节，以便 OpenCtrlC 做出正确的修改。

假设你让 OpenCtrlC 做了一些修改。

请重构 @src/api/session.ts 中的 session handler。

但你发现结果不是你想要的。你可以使用 /undo 命令来撤销修改。

/undo

OpenCtrlC 会还原所做的修改，并重新显示你之前的消息。

请重构 @src/api/session.ts 中的 session handler。

你可以调整提示词，让 OpenCtrlC 重新尝试。

你也可以使用 /redo 命令来重做修改。

/redo

你与 OpenCtrlC 的对话可以与团队分享。

/share

这会生成当前对话的链接并复制到剪贴板。

你可以使用 /share 命令与团队分享会话。

以上就是全部内容！你现在已经是 OpenCtrlC 的使用高手了。