Skip to main content

Open Terminal

A computer for your AI agents. Run commands, search and manage files, execute code, and work with browsers and desktops through a self-hosted REST API. Connect it to Open WebUI, or use it with your own tools.

Documentation · Changelog · Report an issue

Open Terminal in Open WebUI

PyPI License GitHub stars

Installation

Docker

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:latest

The API is available at http://localhost:8000, with interactive docs at /docs. The volume keeps your files between container updates. Replace your-secret-key with your own key.

Image tag Includes
latest Full toolkit: Python, Node.js, build tools, browser, desktop, and document tools
agents Everything in latest, plus the latest Codex and Claude Code CLIs
cuda Full environment with CUDA toolkit and GPU-enabled PyTorch
slim Minimal Debian environment with git, curl, and jq
alpine Minimal Alpine environment with git, curl, and jq
openshift Minimal image for OpenShift restricted non-root policies

Use :agents to run codex or claude from a terminal, signing in with your own account. See the deployment guide for agent setup, image capabilities, custom packages, and updates.

Python

Requires Python 3.11+.

# uv (replace your-secret-key)
uvx open-terminal@latest run --host 0.0.0.0 --port 8000 --api-key your-secret-key

# Or pip
pip install open-terminal
open-terminal run --host 0.0.0.0 --port 8000

Linux defaults to a separate XFCE desktop. Select GNOME explicitly with --desktop-environment gnome. GNOME supports Wayland-only systems such as Ubuntu 26.04; it uses noVNC when the optional x11vnc package is installed and the frame viewer otherwise. XFCE and older GNOME X11 sessions use noVNC. See desktop setup for required packages. Keep your existing display manager if prompted during installation. Docker latest includes XFCE and its dependencies. Sharing your actual logged-in desktop requires --desktop-mode host.

For GNOME Wayland audio, install pipewire-pulse pulseaudio-utils ffmpeg, restart Open Terminal, and click the viewer's speaker button to unmute. Audio is optional and works with either viewer.

Host desktop audio is also supported on Linux, macOS 13+, and Windows. Install FFmpeg and follow the host audio setup, then unmute in the viewer to share system sound.

If no API key is configured, one is generated and printed at startup. For Docker, find it with docker logs open-terminal.

Private local IPC

Desktop clients can use the existing HTTP/WebSocket API without opening a TCP listener:

# macOS/Linux: use a socket inside a directory owned by the current user (mode 0700).
open-terminal run --isolated --ipc /path/to/private-directory/api.sock

On Windows, use a local named pipe, for example open-terminal run --isolated --ipc \\.\pipe\open-terminal-private. API-key authentication still applies. --port 8000 adds a TCP listener; it binds to 127.0.0.1 unless --host 0.0.0.0 is explicitly supplied. Use port 0 to select an available port. The bind address and port are logged at startup. With --ipc, --host requires an explicit --port; --cftunnel is not supported.

Connect to Open WebUI

  1. Open Settings → Admin → Integrations → Open Terminal.
  2. Add a URL reachable from the Open WebUI server and your API key.
  3. Enable the connection and select the terminal in chat.

Use the dedicated Open Terminal section to get the file browser and terminal panel. Compare connection modes, or see the connection guide for Docker networking and personal connections.

Configuration

Coding agents in chat

Install and sign in to the agent CLIs as the user running Open Terminal. In a compatible Open WebUI checkout, selecting this terminal adds its discovered models to the existing model selector as <agent>/<model>. Agent conversations run in the terminal's current directory, with streaming output, native tool/extension approvals, attachments, Stop, and conversation continuation.

Agent Native interface Executable override
Codex codex app-server --listen stdio:// OPEN_TERMINAL_CODEX_COMMAND
Claude Code claude --input-format stream-json --output-format stream-json OPEN_TERMINAL_CLAUDE_COMMAND
Cursor agent acp OPEN_TERMINAL_CURSOR_COMMAND
Grok grok --no-auto-update agent stdio OPEN_TERMINAL_GROK_COMMAND
OpenCode opencode acp OPEN_TERMINAL_OPENCODE_COMMAND
Cline cline --acp OPEN_TERMINAL_CLINE_COMMAND
Gemini CLI gemini --acp OPEN_TERMINAL_GEMINI_COMMAND
Pi pi --mode rpc OPEN_TERMINAL_PI_COMMAND

These adapters target current CLI protocols. ACP model discovery prefers session config options and also reads the native models field still advertised by current agents such as Gemini. Pi requires the current RPC agent_settled completion event and --session-id support. There are no hardcoded model lists. Log in through the CLI before using WebUI; the integration does not run interactive login flows. ACP agents execute their own filesystem and terminal tools in this environment. Pi follows its native tool policy; WebUI forwards extension confirmation dialogs but does not add a separate per-tool permission layer.

ACP history replay is suppressed when resuming an already saved WebUI conversation. If an agent does not advertise native resume, the next turn receives the saved conversation text instead. Agent-specific editor extensions beyond ACP's standard permissions and form elicitation are not implemented.

The same flow works through Tether's saved connection and outbound relay; the hosted server does not need to reach the local machine's IP. All three applications need the agent-capable changes. Provider CLIs and their login credentials stay in the terminal environment; no provider SDK is required in WebUI. Executable overrides above accept a path to the installed CLI.

The authenticated /agents catalog advertises installed providers and models. POST /agents/{provider}/sessions starts an owned process; /agents/sessions/{id} inspects or deletes it. Its /connect WebSocket carries native JSONL inside sequenced input/output frames with acknowledgements and replay. Sessions require X-User-Id and X-Session-Id ownership headers (single-user clients may omit X-User-Id). WebSocket clients send an initial { "type": "auth", "token": "<API key>", "cursor": 0 } frame. Agent turns use a single backend task and resume the provider's saved conversation on the next turn; branching/regeneration requires a new chat.

Server settings

Configure Open Terminal with CLI flags, environment variables, or a TOML file. CLI flags take precedence.

Guide Covers
Configuration Config files, browser sessions, storage, and file previews
Deployment Docker variants, coding agents, custom packages, updates, and multi-user setup
Temporary public access Cloudflare tunnels and troubleshooting
API reference Interactive endpoints on your running instance

Multi-user deployments

Built-in multi-user mode separates workspaces inside one shared container; it does not isolate users and is intended for small, trusted deployments.

For separate containers per user, use Terminals. Production use requires an Open WebUI Enterprise License. See the security policy for the trust model.

Support

Open an issue for bugs or setup problems. Report vulnerabilities privately through GitHub Security Advisories.

Star History

Star History Chart

License

MIT. Bundled third-party tools retain their own licenses and terms.

Metadata

Release files for open-terminal 0.17.18

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for open-terminal 0.17.18
File Size Uploaded Provenance Actions
open_terminal-0.17.18.tar.gz 433.8 kB With provenance Details for open_terminal-0.17.18.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for open-terminal 0.17.18
File Interpreter ABI Platform Actions
open_terminal-0.17.18-py3-none-any.whl Python 3 none any Details for open_terminal-0.17.18-py3-none-any.whl

Total release size: 593.6 kB

Release files / open_terminal-0.17.18.tar.gz

Download URL open_terminal-0.17.18.tar.gz
Size 433.8 kB
Tags Source
SHA-256 checksum
How to use checksums
7b58762abb1a1cc9ba51115a38cb26e5fb5718dec5a42da890360feaba4a9b39
BLAKE2b-256 checksum
How to use checksums
b2610e09157994a83f619f3bb8c6ce3631a97e07b6d0404a30585edefa08f47c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Release files / open_terminal-0.17.18-py3-none-any.whl

Download URL open_terminal-0.17.18-py3-none-any.whl
Size 159.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
310b8f8f7ad433a162daf68e30454d2ac1d6e535a0c469486c840cf6436efd39
BLAKE2b-256 checksum
How to use checksums
8455a68036892d743d95630a7a5dee8b8da1b7bf8bb59444e6e4277ea4e26b8f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Security for open-terminal 0.17.18

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for open_terminal-0.17.18.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.17.18 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page