⌨️ 🦾 Zsh Codex

命令行中的人工智能。

你只需要写下注释或变量名，AI 就会为你写出相应的代码。

这是什么？

这是一个 ZSH 插件，它让你可以在命令行中使用由 AI 驱动的代码补全功能。目前支持 OpenAI 的 Codex 和 Google 的生成式 AI（Gemini）。OpenAI Codex 是 GitHub Copilot 背后使用的 AI 模型，而 Gemini 则是 Google 的先进语言模型。

如何安装？

手动安装

1. 安装 OpenAI 包、Google 包或 boto3。

pip3 install openai

或者

pip3 install google-generativeai

或者

pip3 install boto3

2. 下载 ZSH 插件。

git clone https://github.com/tom-doerr/zsh_codex.git ~/.oh-my-zsh/custom/plugins/zsh_codex 

3. 在你的 .zshrc 文件中添加以下内容。

使用 oh-my-zsh：

    plugins=(zsh_codex)
    bindkey '^X' create_completion

不使用 oh-my-zsh：

    # 在你的自定义路径下需要有一个 "plugins" 文件夹，并在其中克隆 zsh_codex 仓库
    export ZSH_CUSTOM="your/custom/path"
    source "$ZSH_CUSTOM/plugins/zsh_codex/zsh_codex.plugin.zsh"
    bindkey '^X' create_completion

4. 在 ~/.config 目录下创建一个名为 zsh_codex.ini 的文件。示例：

; 主要服务配置
; 将 'service' 设置为下面定义的其中一个部分。
[service]
service = groq_service

; 自托管 Ollama 服务的示例配置。
[my_ollama]
api_type = openai
api_key = dummy_key
model = llama3.1
base_url = http://localhost:11434/v1

; OpenAI 服务配置
; 提供 'api_key'，并在需要时指定 'model'。
[openai_service]
api_type = openai
api_key = <openai_apikey>

; Groq 服务配置
; 提供 'api_key'。
[groq_service]
api_type = groq
api_key = <groq_apikey>
model = gemma2-9b-it

; Mistral 服务配置
; 提供 'api_key'。
[mistral_service]
api_type = mistral
api_key = <mistral_apikey>
model = mistral-small-latest

在这个配置文件中，你可以定义多个具有各自配置的服务。api_type 的必填和可选参数在 services/sevices.py 中指定。在 [service] 部分选择你要使用的服务。

6. 运行 zsh，开始输入并使用 ^X 来完成代码！
7. 如果你使用虚拟环境，可以将 ZSH_CODEX_PYTHON 设置为安装了 openai 或 google-generativeai 的 Python 可执行文件。 例如，对于 miniconda，你可以使用：

export ZSH_CODEX_PYTHON="$HOME/miniconda3/bin/python"

Fig 安装

故障排除

未处理的 ZLE 小部件 'create_completion'

zsh-syntax-highlighting: 未处理的 ZLE 小部件 'create_completion'
zsh-syntax-highlighting: （这有时是因为在没有使用 `zle -N` 或 `zle -C` 创建 'create_completion' 小部件的情况下执行了 `bindkey <keys> create_completion`。）

在调用 bindkey 之前，但在加载插件（plugins=(zsh_codex)）之后，添加以下行：

zle -N create_completion

目标目录已存在且非空

fatal: destination path '~.oh-my-zsh/custom/plugins'

尝试再次下载 ZSH 插件。

git clone https://github.com/tom-doerr/zsh_codex.git ~/.oh-my-zsh/custom/plugins/zsh_codex

---

传递上下文

由于当前的文件系统不会传递给 AI，你需要要么

1. 在描述性命令中直接传递所有上下文
2. 使用一个命令来收集上下文

为了使选项 2 能够工作，你需要先在 .zshrc 文件中添加 export ZSH_CODEX_PREEXECUTE_COMMENT="true" 来启用该功能。

[!WARNING] 这将在每次使用前运行你的 zsh 提示符，这可能会在你按下 ^X 时修改你的系统。

完成这些操作并重启 shell 后，你可以这样操作：

# git add 所有文件。同时根据 $(git diff) 的内容提交当前的更改集，并附上描述性信息。然后 git push

更多使用示例

---

Fish 版本

流量统计

zsh_codex 快速上手指南

zsh_codex 是一个强大的 ZSH 插件，让你在命令行中直接利用 AI（支持 OpenAI Codex、Google Gemini、Groq、Mistral 及本地 Ollama 等模型）进行代码补全。只需输入注释或变量名，按下快捷键即可生成对应的 Shell 命令。

环境准备

在开始之前，请确保你的系统满足以下条件：

• 操作系统: macOS 或 Linux
• Shell: 必须使用 Zsh
• Python: 已安装 Python 3 及 pip
• 前置依赖: 根据你选择的 AI 服务商，需安装对应的 Python 库（任选其一或多选）：
  • OpenAI/Groq/Mistral/Ollama: pip3 install openai
  • Google Gemini: pip3 install google-generativeai
  • AWS Bedrock: pip3 install boto3

安装步骤

1. 下载插件

将插件克隆到 Oh My Zsh 的自定义插件目录：

git clone https://github.com/tom-doerr/zsh_codex.git ~/.oh-my-zsh/custom/plugins/zsh_codex

2. 配置 Zsh

编辑你的 ~/.zshrc 文件，添加插件并绑定快捷键（默认为 Ctrl+X）：

如果你使用 Oh My Zsh：

plugins=(zsh_codex)
bindkey '^X' create_completion
zle -N create_completion

注意：zle -N create_completion 这一行非常重要，需放在 bindkey 之前或之后，但在插件加载后，用于避免 "Unhandled ZLE widget" 错误。

如果你不使用 Oh My Zsh：

export ZSH_CUSTOM="your/custom/path" # 替换为你的实际路径
source "$ZSH_CUSTOM/plugins/zsh_codex/zsh_codex.plugin.zsh"
bindkey '^X' create_completion
zle -N create_completion

3. 配置 API 密钥

在 ~/.config 目录下创建名为 zsh_codex.ini 的配置文件。你可以在其中配置多个服务，并通过 [service] 字段指定默认使用的服务。

示例配置 (~/.config/zsh_codex.ini)：

; 选择默认服务 (需与下方定义的 section 名称一致)
[service]
service = openai_service

; OpenAI 配置
[openai_service]
api_type = openai
api_key = <你的_openai_api_key>
model = gpt-3.5-turbo-instruct

; Groq 配置 (速度快，免费额度多)
[groq_service]
api_type = groq
api_key = <你的_groq_api_key>
model = gemma2-9b-it

; 本地 Ollama 配置
[my_ollama]
api_type = openai
api_key = dummy_key
model = llama3.1
base_url = http://localhost:11434/v1

请将 <你的_..._api_key> 替换为真实的 API Key。

4. 生效配置

保存文件后，重启终端或运行以下命令使配置生效：

source ~/.zshrc

(可选) 如果你使用 Python 虚拟环境（如 conda），且 AI 库安装在特定环境中，请设置以下环境变量：

export ZSH_CODEX_PYTHON="$HOME/miniconda3/bin/python"

基本使用

安装完成后，在命令行中输入自然语言描述或注释，然后按下 Ctrl + X 即可触发 AI 补全。

使用示例：

1. 生成命令： 输入以下内容（以 # 开头作为注释）：

   # 查找当前目录下所有大于 100MB 的文件并按大小排序
   

   按下 Ctrl + X，AI 会自动将其替换为：

   find . -type f -size +100M -exec ls -lh {} \; | sort -k5 -hr
   

2. 基于上下文生成（高级用法）： 若需在 .zshrc 中启用 export ZSH_CODEX_PREEXECUTE_COMMENT="true"，你可以结合当前命令输出生成新命令：

   # git add all files. Also commit the current changeset with a descriptive message based on $(git diff). Then git push
   

   按下 Ctrl + X，AI 会解析 $(git diff) 的结果并生成完整的提交和推送命令。

3. 取消操作： 如果生成的命令不符合预期，直接按 Ctrl + C 取消即可，不会执行任何操作。