一个 CLI（命令行工具），可将自然语言转换为 Shell 命令。

灵感来源于 GitHub Copilot X CLI，但对所有人开源。

AI Shell

安装设置

Node.js 的最低支持版本为 v14

1. 安装 ai shell：

   npm install -g @builder.io/ai-shell
   

2. 从 OpenAI 获取您的 API 密钥

   注意：如果您还没有账户，需要创建账户并设置计费信息。

3. 设置密钥以便 ai-shell 可以使用：

   ai config set OPENAI_KEY=<your token>
   

   这将在您的主目录中创建一个 .ai-shell 文件。

使用方法

ai <prompt>

例如：

ai list all log files

然后您将得到如下输出，您可以选择运行建议的命令、通过提示修改命令或取消：

◇  Your script:
│
│  find . -name "*.log"
│
◇  Explanation:
│
│  1. Searches for all files with the extension ".log" in the current directory and any subdirectories.
│
◆  Run this script?
│  ● ✅ Yes (Lets go!)
│  ○ 📝 Revise
│  ○ ❌ Cancel
└

特殊字符

请注意，某些 Shell 会特殊处理某些字符，如 ? 或 * 或类似文件路径的内容。如果您遇到奇怪的行为，可以将提示词用引号包裹以避免问题，如下所示：

ai 'what is my ip address'

聊天模式

ai chat

使用此模式，您可以通过 CLI 直接与 AI 进行对话，并以自然、对话的方式获得有用的回复：

┌  Starting new conversation
│
◇  You:
│  how do I serve a redirect in express
│
◇  AI Shell:

In Express, you can use the `redirect()` method to serve a redirect. The `redirect()` method takes one argument, which is the URL that you want to redirect to.

Here's an example:

\`\`\`js
app.get('/oldurl', (req, res) => {
  res.redirect('/newurl');
});
\`\`\`

静默模式（跳过解释）

您可以使用标志 -s 或 --silent 禁用并跳过解释部分

ai -s list all log files

或者使用以下命令将选项保存为首选设置：

ai config set SILENT_MODE=true

自定义 API 端点

您可以自定义 OpenAI API 端点以设置 OPENAI_API_ENDPOINT（默认值：https://api.openai.com/v1）

ai config set OPENAI_API_ENDPOINT=<your proxy endpoint>

设置语言

AI Shell 的默认语言是英语，但您可以使用相应的语言键轻松切换到您喜欢的语言，如下所示：

语言	键
English	en
简体中文	zh-Hans
繁体中文	zh-Hant
Spanish	es
Japanese	jp
Korean	ko
French	fr
German	de
Russian	ru
Ukrainian	uk
Vietnamese	vi
Arabic	ar
Portuguese	pt
Turkish	tr

例如，如果您想切换到简体中文，可以通过将 LANGUAGE 值设置为 zh-Hans 来实现：

ai config set LANGUAGE=zh-Hans

这将把您的语言设置为简体中文。

配置界面

要使用更直观的界面来查看和设置配置选项，您可以输入：

ai config

以获得如下交互式界面：

◆  Set config:
│  ○ OpenAI Key
│  ○ OpenAI API Endpoint
│  ○ Silent Mode
│  ● Model (gpt-4o-mini)
│  ○ Language
│  ○ Cancel
└

升级

使用以下命令检查已安装的版本：

ai --version

如果不是 最新版本，请运行：

npm update -g @builder.io/ai-shell

或者直接运行 AI shell：

ai update

常见问题

429 错误

一些用户报告收到了来自 OpenAI 的 429 错误。这是由于计费设置不正确或配额使用过度造成的。请遵循 此指南 进行修复。

您可以在 此链接 激活计费功能。确保添加支付方式，除非您拥有 OpenAI 的有效赠款。

动机

我不是 Bash 专家，非常渴望使用 Copilot CLI，因此失去了耐心。

贡献

如果您想帮助修复 Issues 中的错误或实现功能（提示：寻找 help wanted 标签），请查看 贡献指南 了解如何设置项目。

致谢

• 感谢 GitHub Copilot 提供的出色工具和这一想法。
• 感谢 Hassan 及其在 aicommits 上的工作，它启发了工作流程和部分代码及流程

ai-shell 快速上手指南

ai-shell 是一款命令行工具（CLI），可将自然语言描述直接转换为可执行的 Shell 命令。灵感源自 GitHub Copilot X CLI，完全开源免费。

环境准备

• 系统要求：Node.js 版本需为 v14 或更高。
• 前置依赖：需要拥有 OpenAI 账号，并完成账户绑定与计费设置以获取 API Key。

安装步骤

1. 安装工具

通过 npm 全局安装 ai-shell：

npm install -g @builder.io/ai-shell

2. 配置 API Key

获取您的 OpenAI API Token 后，在终端中运行以下命令进行配置（将在家目录下创建 .ai-shell 配置文件）：

ai config set OPENAI_KEY=<your token>

3. 设置语言（可选）

默认语言为英文，如需切换为简体中文，请执行：

ai config set LANGUAGE=zh-Hans

💡 提示：也可运行 ai config 进入交互式界面进行图形化配置。

基本使用

生成命令

直接在终端输入 ai 加上您的自然语言描述，即可生成对应的 Shell 脚本。

ai list all log files

交互流程： 工具会展示生成的命令及解释，并提供三个选项：

• ✅ Yes：直接运行该命令
• 📝 Revise：通过对话修改命令
• ❌ Cancel：取消操作

聊天模式

如需与 AI 进行多轮对话或咨询技术问题，可启用聊天模式：

ai chat

静默模式

若不需要显示解释说明，仅希望直接输出命令，可使用 -s 参数：

ai -s list all log files