安装

根据你的需求选择安装方式：

方式	适用场景
Docker	运行在隔离容器中，与宿主系统分离
Bare Metal	AI 直接操作你的本机环境、真实文件与工具
Docker Compose	你已经用 Docker Compose 跑 OPL 数据空间，希望顺带接入 Open Terminal

Docker

需要 Docker。

1. 启动容器

docker run -d \
  --name open-terminal \
  --restart unless-stopped \
  -p 8000:8000 \
  -v open-terminal:/home/user \
  -e OPEN_TERMINAL_API_KEY=your-secret-key \
  ghcr.io/open-webui/open-terminal

把 your-secret-key 替换成你自己的密钥。

命令说明

参数	作用
-d	后台运行
--name open-terminal	指定容器名
--restart unless-stopped	机器重启后自动拉起
-p 8000:8000	暴露 http://localhost:8000
-v open-terminal:/home/user	持久化文件
-e OPEN_TERMINAL_API_KEY=...	设置鉴权密钥

2. 验证

在浏览器中打开 http://localhost:8000/docs。如果一切正常，你会看到 Open Terminal API 页面。

自动生成 API key

如果你没有显式设置 API key，系统会自动生成一个。可通过下面命令查看：

docker logs open-terminal

Bare Metal

注意

在该模式下，AI 能做你当前用户账号能做的任何事情，包括修改或删除文件。

1. 运行 Open Terminal

方式 A：不安装，直接运行

uvx open-terminal run --host 0.0.0.0 --port 8000 --api-key your-secret-key

它会通过 uv 下载并运行，不会做永久安装。

方式 B：通过 pip 安装

pip install open-terminal
open-terminal run --host 0.0.0.0 --port 8000 --api-key your-secret-key

2. 工作目录

Open Terminal 会以当前目录作为文件根目录。如果你想把作用域限制在某个项目里：

cd /path/to/your/project
uvx open-terminal run --host 0.0.0.0 --port 8000 --api-key your-secret-key

Windows

Windows 通过 pywinpty 支持，能够运行 PowerShell、彩色输出以及交互式程序。

Docker Compose

把 Open Terminal 作为一个服务加进已有的 docker-compose.yml：

1. 更新 Compose 文件

services:
  open-webui:
    image: ghcr.io/open-webui/open-webui:latest
    container_name: open-webui
    ports:
      - "3000:8080"
    volumes:
      - open-webui:/app/backend/data

  open-terminal:
    image: ghcr.io/open-webui/open-terminal
    container_name: open-terminal
    volumes:
      - open-terminal:/home/user
    environment:
      - OPEN_TERMINAL_API_KEY=your-secret-key

volumes:
  open-webui:
  open-terminal:

2. 启动服务

docker compose up -d

连接 URL

当两个服务处于同一个 Docker Compose 网络中时，连接地址应使用服务名：

http://open-terminal:8000

此时 localhost 在容器之间并不会互通。

下一步

连接到 OPL 数据空间→