● 开放解释器

抢先体验桌面应用‎ ‎ |‎ ‎ 文档

Open Interpreter 允许大型语言模型在本地运行代码（Python、Javascript、Shell 等）。安装后，您只需在终端中运行 $ interpreter，即可通过类似 ChatGPT 的界面与 Open Interpreter 交流。

这为您的计算机的通用功能提供了一个自然语言接口：

• 创建和编辑照片、视频、PDF 等文件。
• 控制 Chrome 浏览器进行研究。
• 绘制、清洗和分析大型数据集。
• …等等。

⚠️ 注意：在代码执行前，系统会要求您批准。

演示

https://github.com/OpenInterpreter/open-interpreter/assets/63927363/37152071-680d-4423-9af3-64836a6f7b60

Google Colab 上也有一个交互式演示：

还有一个受电影《她》启发的语音交互示例：

快速开始

安装

pip install git+https://github.com/OpenInterpreter/open-interpreter.git

如果无法正常工作？请阅读我们的 设置指南。

终端

安装完成后，只需运行 interpreter：

interpreter

Python

from interpreter import interpreter

interpreter.chat("绘制 AAPL 和 META 的归一化股价") # 执行单个命令
interpreter.chat() # 启动交互式对话

GitHub Codespaces

在本仓库的 GitHub 页面上按下 , 键即可创建一个 codespace。片刻之后，您将获得一个预装了 open-interpreter 的云端虚拟机环境。您可以直接与其互动，并自由确认其执行系统命令的过程，而无需担心对系统造成损害。

与 ChatGPT 的 Code Interpreter 对比

OpenAI 随 GPT-4 推出的 Code Interpreter 为使用 ChatGPT 完成实际任务提供了绝佳机会。

然而，OpenAI 的服务是托管的、闭源的，并且受到严格限制：

• 无互联网访问权限。
• 预装软件包有限。
• 最大上传文件大小为 100 MB，运行时长上限为 120 秒。
• 当环境关闭时，状态（包括生成的文件和链接）会被清除。

---

Open Interpreter 则通过在您的本地环境中运行来克服这些限制。它拥有完全的互联网访问权限，不受时间和文件大小的限制，并且可以使用任何软件包或库。

这将 GPT-4 的 Code Interpreter 的强大功能与您本地开发环境的灵活性相结合。

命令

更新： Generator Update (0.1.5) 引入了流式传输：

message = "我们当前使用的操作系统是什么？"

for chunk in interpreter.chat(message, display=False, stream=True):
  print(chunk)

交互式对话

要在终端中启动交互式对话，您可以从命令行运行 interpreter：

interpreter

或者从 .py 文件中调用 interpreter.chat()：

interpreter.chat()

您也可以逐块流式输出：

message = "我们当前使用的操作系统是什么？"

for chunk in interpreter.chat(message, display=False，stream=True):
  print(chunk)

编程式对话

为了更精确地控制，您可以直接将消息传递给 .chat(message)：

interpreter.chat("为 /videos 目录下的所有视频添加字幕。")

# ... 将输出流式传输到终端，完成任务 ...

interpreter.chat("这些看起来很棒，但你能把字幕再放大一点吗？")

# ...

开始新对话

在 Python 中，Open Interpreter 会记住对话历史。如果您想从头开始，可以将其重置：

interpreter.messages = []

保存和恢复对话

interpreter.chat() 会返回一个消息列表，您可以使用该列表通过 interpreter.messages = messages 来恢复对话：

messages = interpreter.chat("我叫基利安。") # 将消息保存到 'messages'
interpreter.messages = [] # 重置解释器 ("基利安" 将被遗忘)

interpreter.messages = messages # 从 'messages' 恢复对话 ("基利安" 将被记住)

自定义系统消息

您可以查看并配置 Open Interpreter 的系统消息，以扩展其功能、修改权限或提供更多上下文。

interpreter.system_message += """
以 -y 参数运行 shell 命令，这样用户就不需要确认了。
"""
print(interpreter.system_message)

更改语言模型

Open Interpreter 使用 LiteLLM 连接到托管的语言模型。

可以通过设置 model 参数来更改模型：

interpreter --model gpt-3.5-turbo
interpreter --model claude-2
interpreter --model command-nightly

在 Python 中，在对象上设置模型：

interpreter.llm.model = "gpt-3.5-turbo"

在此处查找适合您语言模型的“model”字符串。

在本地运行 Open Interpreter

终端

Open Interpreter 可以使用兼容 OpenAI 的服务器在本地运行模型。（例如 LM Studio、jan.ai、ollama 等）

只需使用推理服务器的 api_base URL 运行 interpreter 命令（对于 LM Studio，默认是 http://localhost:1234/v1）：

interpreter --api_base "http://localhost:1234/v1" --api_key "fake_key"

或者，您也可以不安装任何第三方软件，直接通过运行以下命令来使用 Llamafile：

interpreter --local

如需更详细的指南，请观看 Mike Bird 的视频。

如何在后台运行 LM Studio。

1. 下载 https://lmstudio.ai/ 并启动它。
2. 选择一个模型，然后点击 ↓ 下载。
3. 点击左侧的 ↔️ 按钮（位于 💬 下方）。
4. 在顶部选择您的模型，然后点击 启动服务器。

服务器启动后，您就可以开始与 Open Interpreter 对话了。

注意： 本地模式会将您的 context_window 设置为 3000，max_tokens 设置为 1000。如果您的模型有不同的要求，请手动设置这些参数（见下文）。

Python

我们的 Python 包让您对每个设置拥有更多控制权。要复制并连接到 LM Studio，请使用以下设置：

from interpreter import interpreter

interpreter.offline = True # 禁用在线功能，如 Open Procedures
interpreter.llm.model = "openai/x" # 告诉 OI 使用 OpenAI 格式发送消息
interpreter.llm.api_key = "fake_key" # 我们用来与 LM Studio 通信的 LiteLLM 需要此密钥
interpreter.llm.api_base = "http://localhost:1234/v1" # 将其指向任何兼容 OpenAI 的服务器

interpreter.chat()

上下文窗口和最大标记数

您可以修改本地运行模型的 max_tokens 和 context_window（以标记数为单位）。

对于本地模式，较小的上下文窗口会占用更少的内存，因此我们建议在出现故障或运行缓慢时尝试使用更短的窗口（约 1000）。请确保 max_tokens 小于 context_window。

interpreter --local --max_tokens 1000 --context_window 3000

详细模式

为了帮助您检查 Open Interpreter，我们提供了一个用于调试的 --verbose 模式。

您可以通过使用该标志（interpreter --verbose）或在对话过程中激活详细模式：

$ interpreter
...
> %verbose true <- 打开详细模式

> %verbose false <- 关闭详细模式

交互模式命令

在交互模式中，您可以使用以下命令来提升体验。以下是可用命令列表：

可用命令：

• %verbose [true/false]: 切换详细模式。不带参数或使用 true 时进入详细模式。使用 false 时退出详细模式。
• %reset: 重置当前会话的对话。
• %undo: 从消息历史中移除上一条用户消息及 AI 的回复。
• %tokens [prompt]: （实验性）计算下一条提示中作为上下文发送的标记数，并估算其成本。如果提供了 prompt，还可以可选地计算该提示的标记数和预估成本。预估成本依赖于 LiteLLM 的 cost_per_token() 方法。
• %help: 显示帮助信息。

配置 / 配置文件

Open Interpreter 允许您使用 yaml 文件设置默认行为。

这提供了一种灵活的方式来配置解释器，而无需每次都更改命令行参数。

运行以下命令以打开配置文件目录：

interpreter --profiles

您可以在那里添加 yaml 文件。默认配置文件名为 default.yaml。

多个配置文件

Open Interpreter 支持多个 yaml 文件，允许您轻松切换不同的配置：

interpreter --profile my_profile.yaml

FastAPI 服务器示例

生成器更新使 Open Interpreter 能够通过 HTTP REST 端点进行控制：

# server.py

from fastapi import FastAPI
from fastapi.responses import StreamingResponse
from interpreter import interpreter

app = FastAPI()

@app.get("/chat")
def chat_endpoint(message: str):
    def event_stream():
        for result in interpreter.chat(message, stream=True):
            yield f"data: {result}\n\n"

    return StreamingResponse(event_stream(), media_type="text/event-stream")

@app.get("/history")
def history_endpoint():
    return interpreter.messages

pip install fastapi uvicorn
uvicorn server:app --reload

您也可以通过简单运行 interpreter.server() 来启动与上述相同的服务器。

安卓

在 open-interpreter-termux 仓库 中可以找到在您的 Android 设备上安装 Open Interpreter 的分步指南。

安全提示

由于生成的代码会在您的本地环境中执行，它可能会与您的文件和系统设置交互，从而导致意外后果，例如数据丢失或安全风险。

⚠️ Open Interpreter 在执行代码前会请求用户确认。

您可以通过运行 interpreter -y 或将 interpreter.auto_run = True 来绕过此确认，在这种情况下：

• 请求修改文件或系统设置的命令时务必小心。
• 请像对待自动驾驶汽车一样密切关注 Open Interpreter，并准备好通过关闭终端来终止进程。
• 考虑在受限环境（如 Google Colab 或 Replit）中运行 Open Interpreter。这些环境更加隔离，可以降低执行任意代码的风险。

目前还存在一项【实验性】支持的安全模式，有助于缓解部分风险。

工作原理是什么？

Open Interpreter 为一个具有函数调用能力的语言模型（function-calling language model）配备了一个 exec() 函数，该函数接受一种“语言”（如 “Python” 或 “JavaScript”）和要运行的“代码”。

随后，我们将模型的消息、代码以及您系统的输出以 Markdown 格式流式传输到终端。

离线访问文档

完整的 文档 可以随时随地访问，无需互联网连接。

Node 是先决条件：

• 版本 18.17.0 或任何更高版本的 18.x.x 系列。
• 版本 20.3.0 或任何更高版本的 20.x.x 系列。
• 从 21.0.0 开始的任何版本，没有上限限制。

安装 Mintlify：

npm i -g mintlify@latest

进入文档目录并运行相应命令：

# 假设您位于项目的根目录
cd ./docs

# 启动文档服务器
mintlify dev

此时应会打开一个新的浏览器窗口。只要文档服务器运行着，您就可以在 http://localhost:3000 访问文档。

贡献

感谢您对贡献的兴趣！我们欢迎社区成员的参与。

请参阅我们的贡献指南，了解更多关于如何参与的信息。

路线图

访问我们的路线图，预览 Open Interpreter 的未来发展方向。

注意：本软件与 OpenAI 无任何关联。

拥有一个能以指尖速度工作的初级程序员……可以让新的工作流程变得轻松高效，同时也为更多人打开了编程的大门。

— OpenAI 的 Code Interpreter 发布声明

Open Interpreter 快速上手指南

Open Interpreter 是一款让大语言模型（LLM）在本地运行代码（Python、JavaScript、Shell 等）的开源工具。它通过终端提供类似 ChatGPT 的交互界面，赋予自然语言控制电脑的能力，如数据处理、文件操作、浏览器自动化等。

⚠️ 安全提示：生成的代码在执行前会请求用户确认。如需自动执行，请谨慎使用并建议在隔离环境中运行。

环境准备

• 操作系统：Windows、macOS 或 Linux
• Python 版本：建议 Python 3.8 及以上
• 依赖管理：需安装 pip 包管理工具
• 网络要求：首次安装需访问 GitHub 和 PyPI；若使用在线模型（如 GPT-4），需确保网络通畅
• 可选本地模型：若希望完全离线运行，可预先安装 LM Studio、Ollama 或 jan.ai 等本地推理服务

安装步骤

方式一：通过 pip 安装（推荐）

pip install git+https://github.com/OpenInterpreter/open-interpreter.git

如遇下载缓慢，可尝试配置国内 pip 镜像源（如清华源）：

pip install git+https://github.com/OpenInterpreter/open-interpreter.git -i https://pypi.tuna.tsinghua.edu.cn/simple

方式二：本地模式（无需额外服务端）

安装后直接使用 --local 参数即可调用内置的轻量级本地模型支持（基于 llamafile）：

interpreter --local

基本使用

1. 启动交互式终端

安装完成后，在终端直接运行：

interpreter

随后即可输入自然语言指令，例如：

Plot the stock prices of AAPL and META

系统会生成代码并询问是否执行，输入 y 确认后即可运行。

2. 在 Python 脚本中调用

from interpreter import interpreter

# 执行单条指令
interpreter.chat("Add subtitles to all videos in /videos.")

# 启动交互式对话
interpreter.chat()

3. 切换大模型

默认使用 OpenAI 模型，可通过参数切换：

interpreter --model gpt-3.5-turbo
interpreter --model claude-2

在 Python 中设置：

interpreter.llm.model = "gpt-3.5-turbo"

支持的所有模型名称请参考 LiteLLM 文档。

4. 本地运行私有模型

若已启动本地兼容 OpenAI API 的服务（如 LM Studio 默认地址为 http://localhost:1234/v1）：

interpreter --api_base "http://localhost:1234/v1" --api_key "fake_key"

或在 Python 中配置：

from interpreter import interpreter

interpreter.offline = True
interpreter.llm.model = "openai/x"
interpreter.llm.api_key = "fake_key"
interpreter.llm.api_base = "http://localhost:1234/v1"

interpreter.chat()

---

现在你已可以快速开始使用 Open Interpreter。通过自然语言直接操控本地环境，开启高效的开发新体验。