gradio-terminal 1.1.1

A Gradio component that provides a fully functional terminal using xterm.js and PTY

Gradio Terminal

A Gradio component that provides a fully functional terminal in your browser. This package uses xterm.js on the frontend and a PTY on the backend to provide a real shell experience.

Installation

pip install gradio-terminal

Quick Start

Simple Usage

import gradio as gr
from gradio_terminal import Terminal
demo = gr.Blocks()
with demo:
    terminal = Terminal()
demo.launch()

Secure Terminal (No Sudo)

with demo:
    terminal = Terminal(allow_sudo=False)  # Block sudo commands

Terminal with Blacklist

with demo:
    terminal = Terminal(
        blacklist_commands=["rm", "shutdown", "reboot"]  # Block dangerous commands
    )

API Reference

Function	Parameters	Description
launch_terminal()	port=5000, host="127.0.0.1", command="bash", share=False, allow_sudo=True, blacklist_commands=None, **launch_kwargs	Launch a standalone Gradio app with a terminal.
create_terminal_demo()	port=5000, host="127.0.0.1", command="bash", height=400, allow_sudo=True, blacklist_commands=None	Create a Gradio Blocks demo with an embedded terminal.
Terminal()	port=5000, host="127.0.0.1", command="bash", height=400, label=None, visible=True, elem_id=None, elem_classes=None, allow_sudo=True, blacklist_commands=None	Create a terminal component for Gradio Blocks.
TerminalServer()	port=5000, host="127.0.0.1", command="bash"	Low-level terminal server for custom integrations.

TerminalServer Methods

Method	Description
start()	Start the server and return the URL
get_url()	Get the terminal server URL
stop()	Stop the terminal server

Notes

• allow_sudo: Whether to allow sudo commands (default: True). When False, sudo commands are blocked with an error message.
• blacklist_commands: List of commands to block (default: None). Any command in this list will be blocked with an error message.

Security

This component provides shell access to your server. Use the allow_sudo=False parameter to block sudo commands and the blacklist_commands parameter to block specific dangerous commands for enhanced security:

terminal = Terminal(
    allow_sudo=False,
    blacklist_commands=["rm", "shutdown", "reboot", "passwd"]
)

Disclaimer and Security Notice

This component provides shell access to your server, which can pose significant security risks if misused. It should only be used in trusted environments. While this package provides settings such as allow_sudo=False and blacklist_commands to reduce potential threats, it does not guarantee complete security. The authors are not responsible for any misuse or damage caused by this component.

License

This project is licensed under the Apache-2.0 License.

Acknowledgments

• pyxtermjs - Inspiration for the terminal implementation
• xterm.js - Terminal emulator for the browser
• Gradio - The awesome ML demo framework