nprasad2077/open-terminal
1
1 Fork 0
mirror of https://github.com/open-webui/open-terminal.git synced 2026-11-04 08:10:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

refac

Browse Source
This commit is contained in:
Timothy Jaeryang Baek committed 2026-03-01 02:58:51 -06:00
1 parent 5b2358c6f6
commit 1ee96beb6d
1 file changed
+14 -11
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14 -11
View File
@@ -52,22 +52,25 @@ open-terminal run --host 0.0.0.0 --port 8000 --api-key your-secret-key
## Using with Open WebUI
Open Terminal integrates directly with [Open WebUI](https://github.com/open-webui/open-webui), giving your AI assistants the ability to run commands, manage files, and interact with the terminal — right from the chat interface.
Open Terminal integrates with [Open WebUI](https://github.com/open-webui/open-webui), giving your AI assistants the ability to run commands, manage files, and interact with the terminal right from the AI interface. There are two ways to connect:
Once connected, you get:
### Direct Connection
- 🤖 **AI tool access** — your models can execute commands, read/write files, and search your codebase as part of a conversation
- 📁 **Built-in file browser** — browse, upload, download, and manage files on the terminal instance directly from the Open WebUI sidebar
Requests go directly from your **browser**, so the URL must be reachable from your machine.
### Setup
1. Go to **User Settings → Integrations**
2. Add your terminal **URL** and **API key**
3. Enable the connection
1. **Start an Open Terminal instance** (see [Getting Started](#getting-started) above)
2. In Open WebUI, go to **User Settings → Integrations**
3. Under **Open Terminal**, click the **+** button to add a connection
4. Enter the **URL** (e.g. `http://localhost:8000`) and your **API key**
5. **Enable** the connection — only one terminal can be active at a time
### System-Level Connection
That's it — your AI assistants now have access to the terminal, and you can browse files from the sidebar.
Admins can configure multiple terminals and control access 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.
1. Go to **Admin Settings → Integrations**
2. Add the terminal **URL** and **API key**
3. Enable the connection
For isolated, per-user terminal containers, see **[Terminals](https://github.com/open-webui/terminals)**, which requires an enterprise license for production use.
## API Docs