LLM 工作流引擎

LLM 工作流引擎（LWE）是面向 LLM 的强大 CLI 和 工作流管理器。

阅读文档

观看介绍视频

欢迎！

您想做什么？

• 了解该项目
• 安装 LWE
• 学习如何使用
• 阅读文档
• 了解更多关于配置和功能的信息
• 排查常见问题
• 升级 LWE
• 使用 GPT4
• 报告 bug
• 获取支持

原始 ChatGPT 包装项目后来怎么样了？

请参阅 CHATGPT_WRAPPER.md

ChatGPT 包装在当时是一款非常出色的工具，感谢其原始创建者 mmabrouk 的辛勤付出，它如今以全新的形式延续着生命 :)

亮点

🤖 LWE 允许您通过 命令行 使用强大的 ChatGPT/GPT4 机器人。

💬 在 Shell 中运行。您可以在终端中调用并与 ChatGPT/GPT4 交互。

💻 支持官方 ChatGPT API。直接向 OpenAI ChatGPT 端点发起 API 调用（您的 OpenAI 账户可访问的所有支持模型）。

🔌 简单的插件架构。通过自定义功能扩展 LWE。

🗣 支持多个 LLM 提供商。提供商插件允许与其他 LLM（GPT-3、Cohere、Huggingface 等）进行交互。

🔄构建工作流。通过 Ansible Playbook 轻松将对 LLM 的调用集成到更大的工作流中。

🔧 工具使用。（适用于支持的提供商）

🐳 Docker 镜像。LWE 也提供 Docker 镜像。（实验性）

🐍Python API。LWE 还提供 Python 库，让您可以在 Python 脚本中使用 ChatGPT/GPT4。

使用原始 ChatGPT 包装构建的项目

• bookast：书籍的 ChatGPT 播客生成器
• ChatGPT.el：Emacs 中的 ChatGPT
• ChatGPT Reddit 机器人
• Smarty GPT
• ChatGPTify
• selection-to-chatgpt

参与贡献

我们欢迎对 LWE 的贡献！如果您有新功能的想法或发现了 bug，请在 GitHub 仓库中提交一个问题。

许可证

本项目采用 MIT 许可证授权——详情请参阅 LICENSE 文件。

致谢

• 原始 ChatGPT 包装项目（LWE 正是从此发展而来）由 mmabrouk 创建并维护。
• 原始 ChatGPT 包装项目是对 Taranjeet 代码的修改，而该代码又是对 Daniel Gross 代码的修改。

星标历史

LLM Workflow Engine (LWE) 快速上手指南

LLM Workflow Engine (LWE) 是一款强大的命令行工具和工作流管理器，专为与大语言模型（如 ChatGPT/GPT-4）交互而设计。它支持在终端直接调用 API、构建自动化工作流以及通过 Python 脚本集成。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux、macOS 或 Windows (需安装 WSL 或 Git Bash)。
• Python 版本：Python 3.8 或更高版本。
• 依赖项：
  • pip (Python 包管理工具)
  • OpenAI API Key (用于访问官方模型)
• 网络环境：由于需要连接 OpenAI 服务，请确保网络通畅。国内用户建议配置代理或使用符合规定的加速方案。

安装步骤

推荐使用 pip 进行安装。您可以直接使用 PyPI 源，或者使用国内镜像源以加快下载速度。

方式一：使用国内镜像源（推荐）

pip install llm-workflow-engine -i https://pypi.tuna.tsinghua.edu.cn/simple

方式二：使用官方源

pip install llm-workflow-engine

验证安装

安装完成后，运行以下命令检查版本以确认安装成功：

lwe --version

配置 API Key

首次使用前，需要配置您的 OpenAI API Key。运行以下交互式命令：

lwe config

按照提示输入您的 OPENAI_API_KEY。或者，您也可以直接设置环境变量：

export OPENAI_API_KEY="sk-your-api-key-here"

基本使用

LWE 的核心功能是通过命令行与 LLM 进行对话或执行任务。

1. 启动交互式对话

直接在终端输入 lwe 即可进入交互模式，随后您可以像使用聊天机器人一样输入问题：

lwe

示例会话：

> 请用 Python 写一个快速排序算法
< (LLM 返回代码及解释)
> 为这段代码添加注释
< (LLM 返回带注释的代码)

2. 单次命令调用

如果您希望在 Shell 脚本中直接使用或仅获取一次结果，可以使用 -p (prompt) 参数：

lwe -p "解释一下量子纠缠的基本概念"

3. 指定模型

默认情况下，LWE 会使用您账户可用的默认模型。您可以通过 --model 参数指定特定模型（如 gpt-4）：

lwe -p "总结这篇文档" --model gpt-4

4. 结合工作流 (进阶)

LWE 支持将 LLM 调用集成到更大的工作流中（例如配合 Ansible）。您可以查看官方文档了解如何定义复杂的 Workflow 配置文件。

---

更多高级功能（如插件系统、工具调用 Tool Use 及 Docker 部署），请参阅 官方文档。