内容摘录
⚡ Open Terminal
A lightweight, self-hosted terminal that gives AI agents and automation tools a dedicated environment to run commands, manage files, and execute code — all through a simple API.
Why Open Terminal?
AI assistants are great at writing code, but they need somewhere to *run* it. Open Terminal is that place — a remote shell with file management, search, and more, accessible over a simple REST API.
You can run it two ways:
**Docker (sandboxed)** — runs in an isolated container with a full toolkit pre-installed: Python, Node.js, git, build tools, data science libraries, ffmpeg, and more. Great for giving AI agents a safe playground without touching your host system.
**Bare metal** — install it with pip and run it anywhere Python runs. Commands run directly on your machine with access to your real files, your real tools, and your real environment, perfect for local development, personal automation, or giving an AI assistant full access to your actual projects.
Getting Started
Docker (recommended)
That's it — you're up and running at http://localhost:8000.
[!TIP]
If you don't set an API key, one is generated automatically. Grab it with docker logs open-terminal.
Customizing the Docker Environment
The default image ships with a broad set of tools, but you can tailor it to your needs. Fork the repo, edit the Dockerfile to add or remove system packages, Python libraries, or language runtimes, then build your own image:
Bare Metal
No Docker? No problem. Open Terminal is a standard Python package:
[!CAUTION]
On bare metal, commands run directly on your machine with your user's permissions. Use Docker if you want sandboxed execution.
Using with Open WebUI
Open Terminal integrates with Open WebUI, giving your AI assistants the ability to run commands, manage files, and interact with a terminal right from the AI interface. Make sure to add it under **Open Terminal** in the integrations settings, not as a tool server. Adding it as an Open Terminal connection gives you a built-in file navigation sidebar where you can browse directories, upload, download, and edit files. There are two ways to connect:
Direct Connection
Users can connect their own Open Terminal instance from their user settings. This is useful when the terminal is running on their local machine or a network only they can reach, since requests go directly from the **browser**.
Go to **User Settings → Integrations → Open Terminal**
Add the terminal **URL** and **API key**
Enable the connection
System-Level Connection
Admins can configure Open Terminal connections for their users from the admin panel. Multiple terminals can be set up with access controlled at the user or group level. Requests are proxied through the Open WebUI **backend**, so the terminal only needs to be reachable from the server.
Go to **Admin Settings → Integrations → Open Terminal**
Add the terminal **URL** and **API key**
Enable the connection
For isolated, per-user terminal containers, see **Terminals**, which requires an enterprise license for production use.
API Docs
Full interactive API documentation is available at http://localhost:8000/docs once your instance is running.
Star History
<a href="https://star-history.com/#open-webui/open-terminal&Date">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=open-webui/open-terminal&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=open-webui/open-terminal&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=open-webui/open-terminal&type=Date" />
</picture>
</a>
[!TIP]
**Need multi-tenant?** Check out **Terminals**, which provisions and manages isolated Open Terminal containers per user with a single authenticated API entry point.
License
MIT — see LICENSE for details.