https://github.com/javy99/termview
🖥️ termview is a Go-powered tool that lets you run and share any terminal app (like Bash, Python, Go, etc.) in your browser using PTY and WebSockets. Perfect for demos, teaching, or remote debugging.
https://github.com/javy99/termview
cli golang pty remote-access repl terminal webapp websocket xtermjs
Last synced: 11 months ago
JSON representation
🖥️ termview is a Go-powered tool that lets you run and share any terminal app (like Bash, Python, Go, etc.) in your browser using PTY and WebSockets. Perfect for demos, teaching, or remote debugging.
- Host: GitHub
- URL: https://github.com/javy99/termview
- Owner: javy99
- License: mit
- Created: 2025-06-25T21:10:53.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-06-26T08:31:31.000Z (12 months ago)
- Last Synced: 2025-06-26T08:33:31.142Z (12 months ago)
- Topics: cli, golang, pty, remote-access, repl, terminal, webapp, websocket, xtermjs
- Language: Go
- Homepage:
- Size: 5.74 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🖥️ termview
> Share your terminal in the browser using Go, PTY, and WebSockets — works with any CLI app like Bash, Python, Go, etc.
---
## 📥 Installation
You can either **download a prebuilt binary** or **build from source**.
### Option 1: Download from Releases
Go to the [Releases page](https://github.com/javy99/termview/releases) and download the right binary for your OS:
| OS | Download File |
|----------|-------------------|
| Linux | `termview-linux` |
| macOS | `termview-mac` |
| Windows | `termview.exe` |
> ✅ Make the binary executable (Linux/macOS):
> ```bash
> chmod +x termview-linux
> ./termview-linux bash
> ```
Or to build cross-platform binaries manually:
```bash
# Linux
GOOS=linux GOARCH=amd64 go build -o termview-linux
# macOS
GOOS=darwin GOARCH=amd64 go build -o termview-mac
# Windows
GOOS=windows GOARCH=amd64 go build -o termview.exe
```
---
### Option 2: Build from Source (Requires Go)
```bash
git clone https://github.com/javy99/termview.git
cd termview
go build -o termview
```
---
## 🚀 Quick Start
### 1. Build the binary
```bash
go build -o termview
```
### 2. Run any terminal-based app or script
```bash
# Share Bash
./termview bash
# Share a Python REPL
./termview python3
# Share a Python script
./termview python3 ./scripts/hello.py
# Run a Go program
./termview go run myapp.go
# Share any binary or CLI tool
./termview ./my-cli-tool
```
✅ You can run anything that works in a terminal — Bash, Python, Node.js, REPLs, scripts, compiled apps, and more!
### 3. Open in browser
Visit: http://localhost:8080
Use your terminal app live from the browser!
## 📦 What termview Does
termview lets you share any terminal-based application over the web.
- Run any CLI command or REPL (e.g. bash, python3, go run main.go)
- View and interact with it inside your web browser
- Works across devices (even mobile browsers)
- Ideal for teaching, debugging, demos, or remote terminal sessions
## 🔧 Tech Stack
| Component | What It Does |
|----------------|-------------------------------------------------------------|
| **Go** | Backend logic and WebSocket server |
| **PTY** | Creates a fake terminal so apps like `bash` behave normally |
| **xterm.js** | Browser-based terminal emulator |
| **WebSockets** | Two-way live connection between browser and Go server |
| **FileServer** | Serves frontend assets (`index.html`, JS, CSS) |
## 🔄 Architecture Diagram
```text
+--------------------------+
| Your Web Browser |
| (xterm.js terminal UI) |
+------------+-------------+
|
| WebSocket (keyboard ↔ output)
v
+------------+-------------+
| Go WebSocket Server |
| (termview backend) |
+------------+-------------+
|
| PTY (fake terminal device)
v
+--------------------------+
| CLI App (bash, python) |
+--------------------------+
```
## 📁 Project Structure
```text
termview/
├── main.go # App entry point
├── server.go # Server setup and flags
├── internal/
│ └── terminal/
│ └── handler.go # WebSocket + PTY handling logic
├── static/
│ └── index.html # Frontend terminal UI with xterm.js
└── README.md
```
## 📌 Use Cases
- Live coding interviews
- Teaching Python/Bash/Go remotely
- Remote debugging
- Web-based REPL
- Sharing CLI-only tools
## 📜 License
This project is licensed under the [MIT License](LICENSE).
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to open an issue or pull request.
---
## 🛠️ TODO
- [ ] Add password protection
- [ ] Support remote session recording
- [ ] Docker support
- [ ] Multiple user sessions