Shell-AI：让 AI 为你编写 Shell 命令

Shell-AI (shai) 是一款命令行工具，它将自然语言理解的力量带入你的命令行界面。只需用自然语言输入你想做的事情，shai 就会为你推荐能够实现目标的单行命令。在底层，Shell-AI 利用 LangChain 来调用大模型，并基于优秀的 InquirerPy 构建交互式命令行界面。

安装

你可以通过 pip 直接从 PyPI 安装 Shell-AI：

pip install shell-ai

请注意，在 Linux 系统上，需要 Python 3.10 或更高版本。

安装完成后，你可以使用 shai 命令来调用该工具。

使用方法

要使用 Shell-AI，请打开终端并输入以下命令：

shai run terraform dry run thingy

Shell-AI 将会为你提供 3 条建议命令来完成你的请求：

• terraform plan
• terraform plan -input=false
• terraform plan

功能特性

• 自然语言输入：用简单的英文（或其他支持的语言）描述你想要完成的任务。
• 命令建议：获得能够实现你需求的单行命令建议。
• 跨平台：支持 Linux、macOS 和 Windows。
• Azure 兼容性：Shell-AI 现已支持 Azure OpenAI 部署。

配置

Shell-AI 可以通过环境变量或配置文件进行配置，配置文件位于 ~/.config/shell-ai/config.json（Linux/MacOS）或 %APPDATA%\shell-ai\config.json（Windows）。

环境变量

• OPENAI_API_KEY：（必填）你的 OpenAI API 密钥，如果你使用 Ollama，则留空。
• OPENAI_MODEL：要使用的 OpenAI 模型（默认值为 "gpt-3.5-turbo"）。
• OPENAI_API_BASE：要使用的 OpenAI API 或兼容 OpenAI 的 API 端点（默认值为 None）。
• GROQ_API_KEY：（如果使用 Groq 必填）你的 Groq API 密钥。
• SHAI_SUGGESTION_COUNT：生成的建议数量（默认值为 3）。
• SHAI_SKIP_CONFIRM：设置为 "true" 时跳过命令确认。
• SHAI_SKIP_HISTORY：设置为 "true" 时不会将命令写入 shell 历史记录。
• SHAI_API_PROVIDER：选择 "openai"、"ollama"、"azure" 或 "groq" 中的一个作为 API 提供者（默认值为 "groq"）。
• SHAI_TEMPERATURE：控制输出的随机性（默认值为 0.05）。较低的值（如 0.05）会使输出更加专注和确定性，而较高的值（如 0.7）则会使输出更具创造性和多样性。
• CTX：设置为 "true" 时启用上下文模式（注意：输出将会发送到 API）。
• OLLAMA_MODEL：要使用的 Ollama 模型（默认值为 "phi3.5"）。
• OLLAMA_API_BASE：要使用的 Ollama 端点（默认值为 "http://localhost:11434/v1/"）。

配置文件示例

{
  "OPENAI_API_KEY": "your_openai_api_key_here",
  "OPENAI_MODEL": "gpt-3.5-turbo",
  "SHAI_SUGGESTION_COUNT": "3",
  "CTX": true
}

与 OpenAI 兼容的配置示例

{
   "SHAI_API_PROVIDER": "openai",
   "OPENAI_API_KEY": "deepseek_api_key",
   "OPENAI_API_BASE": "https://api.deepseek.com",
   "OPENAI_MODEL": "deepseek-chat",
   "SHAI_SUGGESTION_COUNT": "3",
   "CTX": true
}

MistralAI 的配置示例

{
   "SHAI_API_PROVIDER": "mistral",
   "MISTRAL_API_KEY": "mistral_api_key",
   "MISTRAL_API_BASE": "https://api.mistral.ai/v1",
   "MISTRAL_MODEL": "codestral-2508",
   "SHAI_SUGGESTION_COUNT": "3",
   "CTX": true
}

Ollama 的配置示例

{
   "OPENAI_API_KEY":"",
   "SHAI_SUGGESTION_COUNT": "3",
   "SHAI_API_PROVIDER": "ollama",
   "OLLAMA_MODEL": "phi3.5",
   "OLLAMA_API_BASE": "http://localhost:11434/v1/",
   "SHAI_TEMPERATURE": "0.05"
}

如果存在该配置文件，应用程序将优先读取其中的设置，从而覆盖任何现有的环境变量。

完成上述配置后即可运行应用程序。

与 Groq 配合使用

要将 Shell AI 与 Groq 配合使用：

1. 从 Groq 获取你的 API 密钥。
2. 设置以下环境变量：

   export SHAI_API_PROVIDER=groq
   export GROQ_API_KEY=your_api_key_here
   export GROQ_MODEL=llama-3.3-70b-versatile
   

贡献

这个实现还可以变得更加智能！欢迎提交 Pull Request 分享你的想法，共同让 AI Shell 更加完善。

我们欢迎所有贡献！请阅读 CONTRIBUTING.md 以获取相关指南。

许可证

Shell-AI 采用 MIT 许可证授权。详情请参阅 LICENSE。

Shell-AI 快速上手指南

Shell-AI (shai) 是一款命令行工具，允许你使用自然语言描述需求，它会自动生成对应的 Shell 命令。

环境准备

• 操作系统：Linux、macOS 或 Windows
• Python 版本：Linux 用户需安装 Python 3.10 或更高版本；其他平台建议使用较新的 Python 版本以确保兼容性。
• API Key：你需要准备一个大模型服务的 API Key（默认支持 Groq、OpenAI、Ollama、Azure 等）。若使用本地 Ollama 则无需 Key。

安装步骤

使用 pip 直接从 PyPI 安装：

pip install shell-ai

提示：国内用户若下载缓慢，可使用清华或阿里镜像源加速安装：

pip install shell-ai -i https://pypi.tuna.tsinghua.edu.cn/simple

安装完成后，即可在终端中使用 shai 命令。

基本使用

1. 配置 API (以 Groq 为例)

在使用前，需通过环境变量配置 API Provider 和 Key。以下以免费的 Groq 服务为例：

export SHAI_API_PROVIDER=groq
export GROQ_API_KEY=your_groq_api_key_here
export GROQ_MODEL=llama-3.3-70b-versatile

注：若使用 OpenAI 或 Ollama，请参考官方文档设置对应的 OPENAI_API_KEY 或 OLLAMA_API_BASE 等变量。

2. 运行命令

在终端输入 shai run followed by 你的自然语言描述。例如，想要执行 Terraform 的 dry run：

shai run terraform dry run thingy

3. 选择并执行

工具会列出 3 个建议命令供你选择：

• terraform plan
• terraform plan -input=false
• terraform plan

使用键盘上下键选择最合适的命令，回车确认后，该命令将自动填入当前命令行等待你再次回车执行（除非设置了 SHAI_SKIP_CONFIRM=true）。