ell - 适用于终端环境下与LLMs进行交互轻量级命令行工具

ell 项目介绍

ell 是一个使用 Bash 编写的命令行界面工具，可用于与大型语言模型（LLMs）交互。该工具旨在让用户通过终端直接与 LLMs 进行对话和互动，支持从终端获取上下文信息并进行问题咨询。

功能特性

终端咨询：用户可以通过命令行界面直接向 LLMs 提问。
管道友好：可以与其他工具联动使用，支持从输入流（stdin）读取数据。
终端上下文：用户可以将当前终端的上下文信息直接带入 LLMs，进行相关的问题交互。
聊天功能：支持在终端内与 LLMs 进行聊天互动。
模板支持：通过模板功能支持函数调用和更多扩展特性。

使用要求

要使用 ell，需满足以下软件要求：

Bash 版本 4.1 或更高，且需要核心工具（或 macOS 工具集）
jq用于解析 JSON 数据
curl用于发送 HTTPS 请求
perl和util-linux对脚本模式和正则表达式匹配有帮助，但不在记录模式下使用时非必须。

安装指南

用户可以通过以下命令克隆项目并设置环境变量：

git clone --depth 1 https://github.com/simonmysun/ell.git ~/.ellrc.d
echo 'export PATH="${HOME}/.ellrc.d:${PATH}"' >> ~/.bashrc

或通过 SSH 链接克隆：

git clone --depth 1 git@github.com:simonmysun/ell.git ~/.ellrc.d
echo 'export PATH="${HOME}/.ellrc.d:${PATH}"' >> ~/.bashrc

配置方法

要使用不同的 LLM 模型，用户需要在 ~/.ellrc 文件中配置相应参数。以下是使用 Google 的 gemini-1.5-flash 的示例：

ELL_API_STYLE=gemini
ELL_LLM_MODEL=gemini-1.5-flash
ELL_TEMPLATE=default-gemini
ELL_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
ELL_API_URL=https://generativelanguage.googleapis.com/v1beta/models/

以及使用 OpenAI 的 gpt-4o-mini 的示例：

ELL_API_STYLE=openai
ELL_LLM_MODEL=gpt-4o-mini
ELL_TEMPLATE=default-openai
ELL_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
ELL_API_URL=https://api.openai.com/v1/chat/completions

使用示例

确保配置正确后，用户可以通过以下方式使用 ell：

提问：

ell "What is the capital of France?"

指定模型并使用文件作为输入：

ell -m gpt-4o -f user_prompt.txt

从标准输入读取数据：

cat somecode.py | ell -f -

录制终端输入输出作为上下文：

ell -r
# 执行任务
ell How to fix it?

互动模式：

ell -i

互动模式下，录制功能自动启用，可支持带上下文的聊天。

模板及插件

ell 支持使用模板来扩展功能，具体信息可见模板。此外，用户还可以编写插件来扩展 ell 的功能，详情见插件。

风险考虑

使用 ell 前，请参见风险考虑。

常见问答

为何称为 "ell"?
- ell 是 shell 和 LLM 的结合，简单实用并易于记忆。
为何用 Bash 实现?
- 因为 Bash 是 Unix 系统上最常用的 shell，能够满足该工具的需求。
ell 与类似项目有何不同?
- ell 使用几乎纯 Bash 编写，非常轻量化，易于安装和自定义。

贡献与许可

项目欢迎各类贡献，用户可通过提交问题或请求合并方式参与。该项目基于 MIT 许可证进行分发，具体信息可见 LICENSE 文件。