Skip to content
This repository was archived by the owner on Apr 6, 2026. It is now read-only.

Repository files navigation

Terminal Remote

Access your Mac's terminal sessions from any browser, anywhere.

A menu bar app runs on your Mac, connects to a relay server, and you open the relay's web UI from any device — iPad, laptop, phone — to see and interact with your terminal sessions.

Web UI

Install

curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/install.sh | bash

That's it. Services start immediately and auto-start on login.

To install a specific version:

VERSION=v2.2.0 curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/install.sh | bash

What it does

  • Installs Homebrew dependencies (cloudflared)
  • Downloads the latest release for your architecture (Apple Silicon or Intel)
  • Installs the menu bar app, relay server, and pty-proxy to ~/.terminal-remote/
  • Installs Terminal Remote.app to ~/Applications/
  • Configures shell integration (zsh, bash, or fish)
  • Creates LaunchAgents so services auto-start on login and restart on crash

Prerequisites

  • macOS (Apple Silicon or Intel)
  • Homebrew (for installing cloudflared)

Shell integration

Add one line to your shell rc file so new terminal windows are automatically wrapped in pty-proxy and become remotely accessible:

# ~/.bashrcsource~/.terminal-remote/init.bash
# ~/.zshrcsource~/.terminal-remote/init.zsh
# ~/.config/fish/config.fishsource~/.terminal-remote/init.fish

The pty-proxy is fully transparent — scroll, copy, mouse, and all terminal features work natively. Unlike tmux-based approaches, there are no compatibility issues with your terminal emulator.

Uninstall

curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/uninstall.sh | bash

Removes the app, binaries, LaunchAgents, and shell integration.

Architecture

┌─────────────┐ WebSocket ┌──────────────┐ WebSocket ┌─────────────┐
│ Mac Client │ ◄───────────────► │ Relay Server │ ◄───────────────► │ Browser UI │
│ (menu bar) │ │ (Rust/Axum) │ │ (React) │
└──────┬──────┘ └──────────────┘ └─────────────┘
│
├── pty-proxy (transparent PTY capture per shell)
└── cloudflared (tunnel for remote access)
ComponentDirectoryLanguagePurpose
Mac Clientmac-client/RustMenu bar app, manages pty-proxy sessions, bridges to relay
PTY Proxypty-proxy/RustTransparent PTY wrapper that captures terminal I/O
Relay Serverrelay-server/RustRoutes WebSocket messages between Mac and browsers
Web UIrelay-server/web-ui/TypeScript/ReactTerminal UI with xterm.js, embedded in relay binary
Shell Integrationshell-integration/Bash/Zsh/FishAuto-wraps new shells in pty-proxy

How it works

Connection flow

  1. Mac client starts and connects to the relay server via WebSocket
  2. Relay server generates a 6-character session code
  3. Mac client displays the code in the menu bar
  4. User opens the relay URL in a browser and enters the code
  5. Relay authenticates the browser and pairs it with the Mac client
  6. Browser receives the session list and displays terminal tabs

Terminal I/O

Each shell session is wrapped in a pty-proxy process that sits between the terminal emulator and the shell. The proxy forwards all I/O transparently while sending a copy to the mac-client via Unix socket.

Terminal.app
↕ PTY (transparent)
pty-proxy
├── ↕ Shell (zsh/bash/fish)
└── → Unix socket → Mac client
→ WebSocket to relay
→ Relay broadcasts to browsers
→ xterm.js renders output

Browser input flows in reverse: xterm.js → relay → mac-client → pty-proxy → shell.

Session management

  • Shell integration wraps each new interactive shell in a pty-proxy instance
  • pty-proxy connects to the mac-client via Unix socket (/tmp/terminal-remote.sock)
  • Each proxy sends a registration message (shell, pid, tty) on connect
  • Session connect/disconnect events are broadcast to browsers as JSON control messages
  • The relay maintains a scrollback buffer (1 MB) per session, replayed on browser reconnect

Session codes

  • 6 characters from ABCDEFGHJKMNPQRSTVWXYZ23456789 (no lookalike chars)
  • Case-insensitive entry
  • Generated by the relay server using nanoid

Configuration

Environment variables

Relay Server:

PORT=3000 # Listen port (default: 3000)

Mac Client:

RELAY_URL=ws://localhost:3000/ws # Relay WebSocket URL (default)

Development

Tech stack

LayerTechnology
Mac ClientRust, Tokio, tray-icon, muda, tokio-tungstenite
PTY ProxyRust, nix (PTY/fork/poll), Unix sockets
Relay ServerRust, Axum, Tokio, rust-embed, DashMap
Web UIReact 19, TypeScript 5, Vite 6, xterm.js 6, Zod
Infrastructurecloudflared, Homebrew, LaunchAgents

Building

# Mac client
cargo build -p mac-client
# PTY proxy
cargo build -p pty-proxy
# Relay server (build web UI first)cd relay-server/web-ui && pnpm build
cargo build -p relay-server
# Web UI onlycd relay-server/web-ui && pnpm build

Running locally

# Terminal 1: Relay server
cargo run -p relay-server
# Terminal 2: Mac client
cargo run -p mac-client
# Terminal 3: Web UI dev server (optional, for HMR)cd relay-server/web-ui && pnpm dev

Access via http://localhost:5173 (Vite dev) or http://localhost:3000 (relay with embedded UI).

Testing

cargo test -p mac-client
cargo test -p relay-server

Project structure

ignis-term/
├── mac-client/ # Rust menu bar application
│ └── src/
│ ├── main.rs # Entry point, event loop, menu
│ ├── app.rs # App state, event types
│ ├── protocol.rs # Control message serialization
│ ├── relay/ # WebSocket client with auto-reconnect
│ └── pty/mod.rs # PTY proxy session management
│
├── pty-proxy/ # Transparent PTY wrapper
│ └── src/
│ └── main.rs # PTY fork, I/O forwarding, Unix socket
│
├── relay-server/ # Rust relay server
│ ├── src/
│ │ ├── main.rs # Axum server setup
│ │ ├── state.rs # Session state, scrollback buffer
│ │ ├── protocol.rs # Control message enum
│ │ ├── session.rs # Session code generation
│ │ └── handlers/ws.rs # WebSocket handler (mac + browser)
│ │
│ ├── web-ui/ # React web application
│ │ └── src/
│ │ ├── App.tsx
│ │ ├── routes/ # LoginPage, TerminalPage
│ │ ├── lib/context/ # Connection, Terminal, Tabs contexts
│ │ ├── lib/components/ # Terminal, TerminalTabs, etc.
│ │ └── shared/ # Constants, protocol schemas
│ │
│ └── assets/ # Built web UI (embedded in binary)
│
├── shell-integration/ # Shell init scripts (bash/zsh/fish)
└── scripts/ # install.sh, uninstall.sh

Remote access with Cloudflare Tunnel

The Mac client automatically spawns cloudflared to create a tunnel, providing a public HTTPS URL displayed in the menu bar. No manual tunnel setup required.

For manual tunnel creation:

# Start relay server
cargo run -p relay-server &# Create a quick tunnel
cloudflared tunnel --url http://localhost:3000

Use the generated URL (e.g., https://random-words.trycloudflare.com) in your browser.

Troubleshooting

Session code not working

  • Codes are case-insensitive
  • Ensure the Mac client is still connected to the relay (check menu bar status)
  • Restart the Mac client if needed

Terminal not displaying output

  1. Check that the pty-proxy is running: pgrep pty-proxy
  2. Check the Mac client logs: log stream --predicate 'process == "mac-client"'
  3. Verify the relay server is running

Browser shows "Disconnected"

  • Check the relay server is still running
  • The connection will auto-reconnect with exponential backoff
  • Refresh the page if reconnection fails

Security notes

  • Session codes provide access control (not authentication)
  • Terminal input is passed directly to the shell (no sanitization)
  • For production use, consider adding proper authentication and TLS
  • Cloudflare Tunnel provides encrypted transport for remote access

About

IgnisTerm - Control your Mac terminal from anywhere. Minimal. Powerful.

Topics

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
GitHub - unknown-studio-dev/ignis-term: IgnisTerm - Control your Mac terminal from anywhere. Minimal. Powerful. · GitHub
Skip to content
This repository was archived by the owner on Apr 6, 2026. It is now read-only.

Repository files navigation

Terminal Remote

Access your Mac's terminal sessions from any browser, anywhere.

A menu bar app runs on your Mac, connects to a relay server, and you open the relay's web UI from any device — iPad, laptop, phone — to see and interact with your terminal sessions.

Web UI

Install

curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/install.sh | bash

That's it. Services start immediately and auto-start on login.

To install a specific version:

VERSION=v2.2.0 curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/install.sh | bash

What it does

  • Installs Homebrew dependencies (cloudflared)
  • Downloads the latest release for your architecture (Apple Silicon or Intel)
  • Installs the menu bar app, relay server, and pty-proxy to ~/.terminal-remote/
  • Installs Terminal Remote.app to ~/Applications/
  • Configures shell integration (zsh, bash, or fish)
  • Creates LaunchAgents so services auto-start on login and restart on crash

Prerequisites

  • macOS (Apple Silicon or Intel)
  • Homebrew (for installing cloudflared)

Shell integration

Add one line to your shell rc file so new terminal windows are automatically wrapped in pty-proxy and become remotely accessible:

# ~/.bashrcsource~/.terminal-remote/init.bash
# ~/.zshrcsource~/.terminal-remote/init.zsh
# ~/.config/fish/config.fishsource~/.terminal-remote/init.fish

The pty-proxy is fully transparent — scroll, copy, mouse, and all terminal features work natively. Unlike tmux-based approaches, there are no compatibility issues with your terminal emulator.

Uninstall

curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/uninstall.sh | bash

Removes the app, binaries, LaunchAgents, and shell integration.

Architecture

┌─────────────┐ WebSocket ┌──────────────┐ WebSocket ┌─────────────┐
│ Mac Client │ ◄───────────────► │ Relay Server │ ◄───────────────► │ Browser UI │
│ (menu bar) │ │ (Rust/Axum) │ │ (React) │
└──────┬──────┘ └──────────────┘ └─────────────┘
│
├── pty-proxy (transparent PTY capture per shell)
└── cloudflared (tunnel for remote access)
ComponentDirectoryLanguagePurpose
Mac Clientmac-client/RustMenu bar app, manages pty-proxy sessions, bridges to relay
PTY Proxypty-proxy/RustTransparent PTY wrapper that captures terminal I/O
Relay Serverrelay-server/RustRoutes WebSocket messages between Mac and browsers
Web UIrelay-server/web-ui/TypeScript/ReactTerminal UI with xterm.js, embedded in relay binary
Shell Integrationshell-integration/Bash/Zsh/FishAuto-wraps new shells in pty-proxy

How it works

Connection flow

  1. Mac client starts and connects to the relay server via WebSocket
  2. Relay server generates a 6-character session code
  3. Mac client displays the code in the menu bar
  4. User opens the relay URL in a browser and enters the code
  5. Relay authenticates the browser and pairs it with the Mac client
  6. Browser receives the session list and displays terminal tabs

Terminal I/O

Each shell session is wrapped in a pty-proxy process that sits between the terminal emulator and the shell. The proxy forwards all I/O transparently while sending a copy to the mac-client via Unix socket.

Terminal.app
↕ PTY (transparent)
pty-proxy
├── ↕ Shell (zsh/bash/fish)
└── → Unix socket → Mac client
→ WebSocket to relay
→ Relay broadcasts to browsers
→ xterm.js renders output

Browser input flows in reverse: xterm.js → relay → mac-client → pty-proxy → shell.

Session management

  • Shell integration wraps each new interactive shell in a pty-proxy instance
  • pty-proxy connects to the mac-client via Unix socket (/tmp/terminal-remote.sock)
  • Each proxy sends a registration message (shell, pid, tty) on connect
  • Session connect/disconnect events are broadcast to browsers as JSON control messages
  • The relay maintains a scrollback buffer (1 MB) per session, replayed on browser reconnect

Session codes

  • 6 characters from ABCDEFGHJKMNPQRSTVWXYZ23456789 (no lookalike chars)
  • Case-insensitive entry
  • Generated by the relay server using nanoid

Configuration

Environment variables

Relay Server:

PORT=3000 # Listen port (default: 3000)

Mac Client:

RELAY_URL=ws://localhost:3000/ws # Relay WebSocket URL (default)

Development

Tech stack

LayerTechnology
Mac ClientRust, Tokio, tray-icon, muda, tokio-tungstenite
PTY ProxyRust, nix (PTY/fork/poll), Unix sockets
Relay ServerRust, Axum, Tokio, rust-embed, DashMap
Web UIReact 19, TypeScript 5, Vite 6, xterm.js 6, Zod
Infrastructurecloudflared, Homebrew, LaunchAgents

Building

# Mac client
cargo build -p mac-client
# PTY proxy
cargo build -p pty-proxy
# Relay server (build web UI first)cd relay-server/web-ui && pnpm build
cargo build -p relay-server
# Web UI onlycd relay-server/web-ui && pnpm build

Running locally

# Terminal 1: Relay server
cargo run -p relay-server
# Terminal 2: Mac client
cargo run -p mac-client
# Terminal 3: Web UI dev server (optional, for HMR)cd relay-server/web-ui && pnpm dev

Access via http://localhost:5173 (Vite dev) or http://localhost:3000 (relay with embedded UI).

Testing

cargo test -p mac-client
cargo test -p relay-server

Project structure

ignis-term/
├── mac-client/ # Rust menu bar application
│ └── src/
│ ├── main.rs # Entry point, event loop, menu
│ ├── app.rs # App state, event types
│ ├── protocol.rs # Control message serialization
│ ├── relay/ # WebSocket client with auto-reconnect
│ └── pty/mod.rs # PTY proxy session management
│
├── pty-proxy/ # Transparent PTY wrapper
│ └── src/
│ └── main.rs # PTY fork, I/O forwarding, Unix socket
│
├── relay-server/ # Rust relay server
│ ├── src/
│ │ ├── main.rs # Axum server setup
│ │ ├── state.rs # Session state, scrollback buffer
│ │ ├── protocol.rs # Control message enum
│ │ ├── session.rs # Session code generation
│ │ └── handlers/ws.rs # WebSocket handler (mac + browser)
│ │
│ ├── web-ui/ # React web application
│ │ └── src/
│ │ ├── App.tsx
│ │ ├── routes/ # LoginPage, TerminalPage
│ │ ├── lib/context/ # Connection, Terminal, Tabs contexts
│ │ ├── lib/components/ # Terminal, TerminalTabs, etc.
│ │ └── shared/ # Constants, protocol schemas
│ │
│ └── assets/ # Built web UI (embedded in binary)
│
├── shell-integration/ # Shell init scripts (bash/zsh/fish)
└── scripts/ # install.sh, uninstall.sh

Remote access with Cloudflare Tunnel

The Mac client automatically spawns cloudflared to create a tunnel, providing a public HTTPS URL displayed in the menu bar. No manual tunnel setup required.

For manual tunnel creation:

# Start relay server
cargo run -p relay-server &# Create a quick tunnel
cloudflared tunnel --url http://localhost:3000

Use the generated URL (e.g., https://random-words.trycloudflare.com) in your browser.

Troubleshooting

Session code not working

  • Codes are case-insensitive
  • Ensure the Mac client is still connected to the relay (check menu bar status)
  • Restart the Mac client if needed

Terminal not displaying output

  1. Check that the pty-proxy is running: pgrep pty-proxy
  2. Check the Mac client logs: log stream --predicate 'process == "mac-client"'
  3. Verify the relay server is running

Browser shows "Disconnected"

  • Check the relay server is still running
  • The connection will auto-reconnect with exponential backoff
  • Refresh the page if reconnection fails

Security notes

  • Session codes provide access control (not authentication)
  • Terminal input is passed directly to the shell (no sanitization)
  • For production use, consider adding proper authentication and TLS
  • Cloudflare Tunnel provides encrypted transport for remote access

About

IgnisTerm - Control your Mac terminal from anywhere. Minimal. Powerful.

Topics

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - unknown-studio-dev/ignis-term: IgnisTerm - Control your Mac terminal from anywhere. Minimal. Powerful. · GitHub
Skip to content
This repository was archived by the owner on Apr 6, 2026. It is now read-only.

Repository files navigation

Terminal Remote

Access your Mac's terminal sessions from any browser, anywhere.

A menu bar app runs on your Mac, connects to a relay server, and you open the relay's web UI from any device — iPad, laptop, phone — to see and interact with your terminal sessions.

Web UI

Install

curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/install.sh | bash

That's it. Services start immediately and auto-start on login.

To install a specific version:

VERSION=v2.2.0 curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/install.sh | bash

What it does

  • Installs Homebrew dependencies (cloudflared)
  • Downloads the latest release for your architecture (Apple Silicon or Intel)
  • Installs the menu bar app, relay server, and pty-proxy to ~/.terminal-remote/
  • Installs Terminal Remote.app to ~/Applications/
  • Configures shell integration (zsh, bash, or fish)
  • Creates LaunchAgents so services auto-start on login and restart on crash

Prerequisites

  • macOS (Apple Silicon or Intel)
  • Homebrew (for installing cloudflared)

Shell integration

Add one line to your shell rc file so new terminal windows are automatically wrapped in pty-proxy and become remotely accessible:

# ~/.bashrcsource~/.terminal-remote/init.bash
# ~/.zshrcsource~/.terminal-remote/init.zsh
# ~/.config/fish/config.fishsource~/.terminal-remote/init.fish

The pty-proxy is fully transparent — scroll, copy, mouse, and all terminal features work natively. Unlike tmux-based approaches, there are no compatibility issues with your terminal emulator.

Uninstall

curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/uninstall.sh | bash

Removes the app, binaries, LaunchAgents, and shell integration.

Architecture

┌─────────────┐ WebSocket ┌──────────────┐ WebSocket ┌─────────────┐
│ Mac Client │ ◄───────────────► │ Relay Server │ ◄───────────────► │ Browser UI │
│ (menu bar) │ │ (Rust/Axum) │ │ (React) │
└──────┬──────┘ └──────────────┘ └─────────────┘
│
├── pty-proxy (transparent PTY capture per shell)
└── cloudflared (tunnel for remote access)
ComponentDirectoryLanguagePurpose
Mac Clientmac-client/RustMenu bar app, manages pty-proxy sessions, bridges to relay
PTY Proxypty-proxy/RustTransparent PTY wrapper that captures terminal I/O
Relay Serverrelay-server/RustRoutes WebSocket messages between Mac and browsers
Web UIrelay-server/web-ui/TypeScript/ReactTerminal UI with xterm.js, embedded in relay binary
Shell Integrationshell-integration/Bash/Zsh/FishAuto-wraps new shells in pty-proxy

How it works

Connection flow

  1. Mac client starts and connects to the relay server via WebSocket
  2. Relay server generates a 6-character session code
  3. Mac client displays the code in the menu bar
  4. User opens the relay URL in a browser and enters the code
  5. Relay authenticates the browser and pairs it with the Mac client
  6. Browser receives the session list and displays terminal tabs

Terminal I/O

Each shell session is wrapped in a pty-proxy process that sits between the terminal emulator and the shell. The proxy forwards all I/O transparently while sending a copy to the mac-client via Unix socket.

Terminal.app
↕ PTY (transparent)
pty-proxy
├── ↕ Shell (zsh/bash/fish)
└── → Unix socket → Mac client
→ WebSocket to relay
→ Relay broadcasts to browsers
→ xterm.js renders output

Browser input flows in reverse: xterm.js → relay → mac-client → pty-proxy → shell.

Session management

  • Shell integration wraps each new interactive shell in a pty-proxy instance
  • pty-proxy connects to the mac-client via Unix socket (/tmp/terminal-remote.sock)
  • Each proxy sends a registration message (shell, pid, tty) on connect
  • Session connect/disconnect events are broadcast to browsers as JSON control messages
  • The relay maintains a scrollback buffer (1 MB) per session, replayed on browser reconnect

Session codes

  • 6 characters from ABCDEFGHJKMNPQRSTVWXYZ23456789 (no lookalike chars)
  • Case-insensitive entry
  • Generated by the relay server using nanoid

Configuration

Environment variables

Relay Server:

PORT=3000 # Listen port (default: 3000)

Mac Client:

RELAY_URL=ws://localhost:3000/ws # Relay WebSocket URL (default)

Development

Tech stack

LayerTechnology
Mac ClientRust, Tokio, tray-icon, muda, tokio-tungstenite
PTY ProxyRust, nix (PTY/fork/poll), Unix sockets
Relay ServerRust, Axum, Tokio, rust-embed, DashMap
Web UIReact 19, TypeScript 5, Vite 6, xterm.js 6, Zod
Infrastructurecloudflared, Homebrew, LaunchAgents

Building

# Mac client
cargo build -p mac-client
# PTY proxy
cargo build -p pty-proxy
# Relay server (build web UI first)cd relay-server/web-ui && pnpm build
cargo build -p relay-server
# Web UI onlycd relay-server/web-ui && pnpm build

Running locally

# Terminal 1: Relay server
cargo run -p relay-server
# Terminal 2: Mac client
cargo run -p mac-client
# Terminal 3: Web UI dev server (optional, for HMR)cd relay-server/web-ui && pnpm dev

Access via http://localhost:5173 (Vite dev) or http://localhost:3000 (relay with embedded UI).

Testing

cargo test -p mac-client
cargo test -p relay-server

Project structure

ignis-term/
├── mac-client/ # Rust menu bar application
│ └── src/
│ ├── main.rs # Entry point, event loop, menu
│ ├── app.rs # App state, event types
│ ├── protocol.rs # Control message serialization
│ ├── relay/ # WebSocket client with auto-reconnect
│ └── pty/mod.rs # PTY proxy session management
│
├── pty-proxy/ # Transparent PTY wrapper
│ └── src/
│ └── main.rs # PTY fork, I/O forwarding, Unix socket
│
├── relay-server/ # Rust relay server
│ ├── src/
│ │ ├── main.rs # Axum server setup
│ │ ├── state.rs # Session state, scrollback buffer
│ │ ├── protocol.rs # Control message enum
│ │ ├── session.rs # Session code generation
│ │ └── handlers/ws.rs # WebSocket handler (mac + browser)
│ │
│ ├── web-ui/ # React web application
│ │ └── src/
│ │ ├── App.tsx
│ │ ├── routes/ # LoginPage, TerminalPage
│ │ ├── lib/context/ # Connection, Terminal, Tabs contexts
│ │ ├── lib/components/ # Terminal, TerminalTabs, etc.
│ │ └── shared/ # Constants, protocol schemas
│ │
│ └── assets/ # Built web UI (embedded in binary)
│
├── shell-integration/ # Shell init scripts (bash/zsh/fish)
└── scripts/ # install.sh, uninstall.sh

Remote access with Cloudflare Tunnel

The Mac client automatically spawns cloudflared to create a tunnel, providing a public HTTPS URL displayed in the menu bar. No manual tunnel setup required.

For manual tunnel creation:

# Start relay server
cargo run -p relay-server &# Create a quick tunnel
cloudflared tunnel --url http://localhost:3000

Use the generated URL (e.g., https://random-words.trycloudflare.com) in your browser.

Troubleshooting

Session code not working

  • Codes are case-insensitive
  • Ensure the Mac client is still connected to the relay (check menu bar status)
  • Restart the Mac client if needed

Terminal not displaying output

  1. Check that the pty-proxy is running: pgrep pty-proxy
  2. Check the Mac client logs: log stream --predicate 'process == "mac-client"'
  3. Verify the relay server is running

Browser shows "Disconnected"

  • Check the relay server is still running
  • The connection will auto-reconnect with exponential backoff
  • Refresh the page if reconnection fails

Security notes

  • Session codes provide access control (not authentication)
  • Terminal input is passed directly to the shell (no sanitization)
  • For production use, consider adding proper authentication and TLS
  • Cloudflare Tunnel provides encrypted transport for remote access

About

IgnisTerm - Control your Mac terminal from anywhere. Minimal. Powerful.

Topics

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - unknown-studio-dev/ignis-term: IgnisTerm - Control your Mac terminal from anywhere. Minimal. Powerful. · GitHub
Skip to content
This repository was archived by the owner on Apr 6, 2026. It is now read-only.

Repository files navigation

Terminal Remote

Access your Mac's terminal sessions from any browser, anywhere.

A menu bar app runs on your Mac, connects to a relay server, and you open the relay's web UI from any device — iPad, laptop, phone — to see and interact with your terminal sessions.

Web UI

Install

curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/install.sh | bash

That's it. Services start immediately and auto-start on login.

To install a specific version:

VERSION=v2.2.0 curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/install.sh | bash

What it does

  • Installs Homebrew dependencies (cloudflared)
  • Downloads the latest release for your architecture (Apple Silicon or Intel)
  • Installs the menu bar app, relay server, and pty-proxy to ~/.terminal-remote/
  • Installs Terminal Remote.app to ~/Applications/
  • Configures shell integration (zsh, bash, or fish)
  • Creates LaunchAgents so services auto-start on login and restart on crash

Prerequisites

  • macOS (Apple Silicon or Intel)
  • Homebrew (for installing cloudflared)

Shell integration

Add one line to your shell rc file so new terminal windows are automatically wrapped in pty-proxy and become remotely accessible:

# ~/.bashrcsource~/.terminal-remote/init.bash
# ~/.zshrcsource~/.terminal-remote/init.zsh
# ~/.config/fish/config.fishsource~/.terminal-remote/init.fish

The pty-proxy is fully transparent — scroll, copy, mouse, and all terminal features work natively. Unlike tmux-based approaches, there are no compatibility issues with your terminal emulator.

Uninstall

curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/uninstall.sh | bash

Removes the app, binaries, LaunchAgents, and shell integration.

Architecture

┌─────────────┐ WebSocket ┌──────────────┐ WebSocket ┌─────────────┐
│ Mac Client │ ◄───────────────► │ Relay Server │ ◄───────────────► │ Browser UI │
│ (menu bar) │ │ (Rust/Axum) │ │ (React) │
└──────┬──────┘ └──────────────┘ └─────────────┘
│
├── pty-proxy (transparent PTY capture per shell)
└── cloudflared (tunnel for remote access)
ComponentDirectoryLanguagePurpose
Mac Clientmac-client/RustMenu bar app, manages pty-proxy sessions, bridges to relay
PTY Proxypty-proxy/RustTransparent PTY wrapper that captures terminal I/O
Relay Serverrelay-server/RustRoutes WebSocket messages between Mac and browsers
Web UIrelay-server/web-ui/TypeScript/ReactTerminal UI with xterm.js, embedded in relay binary
Shell Integrationshell-integration/Bash/Zsh/FishAuto-wraps new shells in pty-proxy

How it works

Connection flow

  1. Mac client starts and connects to the relay server via WebSocket
  2. Relay server generates a 6-character session code
  3. Mac client displays the code in the menu bar
  4. User opens the relay URL in a browser and enters the code
  5. Relay authenticates the browser and pairs it with the Mac client
  6. Browser receives the session list and displays terminal tabs

Terminal I/O

Each shell session is wrapped in a pty-proxy process that sits between the terminal emulator and the shell. The proxy forwards all I/O transparently while sending a copy to the mac-client via Unix socket.

Terminal.app
↕ PTY (transparent)
pty-proxy
├── ↕ Shell (zsh/bash/fish)
└── → Unix socket → Mac client
→ WebSocket to relay
→ Relay broadcasts to browsers
→ xterm.js renders output

Browser input flows in reverse: xterm.js → relay → mac-client → pty-proxy → shell.

Session management

  • Shell integration wraps each new interactive shell in a pty-proxy instance
  • pty-proxy connects to the mac-client via Unix socket (/tmp/terminal-remote.sock)
  • Each proxy sends a registration message (shell, pid, tty) on connect
  • Session connect/disconnect events are broadcast to browsers as JSON control messages
  • The relay maintains a scrollback buffer (1 MB) per session, replayed on browser reconnect

Session codes

  • 6 characters from ABCDEFGHJKMNPQRSTVWXYZ23456789 (no lookalike chars)
  • Case-insensitive entry
  • Generated by the relay server using nanoid

Configuration

Environment variables

Relay Server:

PORT=3000 # Listen port (default: 3000)

Mac Client:

RELAY_URL=ws://localhost:3000/ws # Relay WebSocket URL (default)

Development

Tech stack

LayerTechnology
Mac ClientRust, Tokio, tray-icon, muda, tokio-tungstenite
PTY ProxyRust, nix (PTY/fork/poll), Unix sockets
Relay ServerRust, Axum, Tokio, rust-embed, DashMap
Web UIReact 19, TypeScript 5, Vite 6, xterm.js 6, Zod
Infrastructurecloudflared, Homebrew, LaunchAgents

Building

# Mac client
cargo build -p mac-client
# PTY proxy
cargo build -p pty-proxy
# Relay server (build web UI first)cd relay-server/web-ui && pnpm build
cargo build -p relay-server
# Web UI onlycd relay-server/web-ui && pnpm build

Running locally

# Terminal 1: Relay server
cargo run -p relay-server
# Terminal 2: Mac client
cargo run -p mac-client
# Terminal 3: Web UI dev server (optional, for HMR)cd relay-server/web-ui && pnpm dev

Access via http://localhost:5173 (Vite dev) or http://localhost:3000 (relay with embedded UI).

Testing

cargo test -p mac-client
cargo test -p relay-server

Project structure

ignis-term/
├── mac-client/ # Rust menu bar application
│ └── src/
│ ├── main.rs # Entry point, event loop, menu
│ ├── app.rs # App state, event types
│ ├── protocol.rs # Control message serialization
│ ├── relay/ # WebSocket client with auto-reconnect
│ └── pty/mod.rs # PTY proxy session management
│
├── pty-proxy/ # Transparent PTY wrapper
│ └── src/
│ └── main.rs # PTY fork, I/O forwarding, Unix socket
│
├── relay-server/ # Rust relay server
│ ├── src/
│ │ ├── main.rs # Axum server setup
│ │ ├── state.rs # Session state, scrollback buffer
│ │ ├── protocol.rs # Control message enum
│ │ ├── session.rs # Session code generation
│ │ └── handlers/ws.rs # WebSocket handler (mac + browser)
│ │
│ ├── web-ui/ # React web application
│ │ └── src/
│ │ ├── App.tsx
│ │ ├── routes/ # LoginPage, TerminalPage
│ │ ├── lib/context/ # Connection, Terminal, Tabs contexts
│ │ ├── lib/components/ # Terminal, TerminalTabs, etc.
│ │ └── shared/ # Constants, protocol schemas
│ │
│ └── assets/ # Built web UI (embedded in binary)
│
├── shell-integration/ # Shell init scripts (bash/zsh/fish)
└── scripts/ # install.sh, uninstall.sh

Remote access with Cloudflare Tunnel

The Mac client automatically spawns cloudflared to create a tunnel, providing a public HTTPS URL displayed in the menu bar. No manual tunnel setup required.

For manual tunnel creation:

# Start relay server
cargo run -p relay-server &# Create a quick tunnel
cloudflared tunnel --url http://localhost:3000

Use the generated URL (e.g., https://random-words.trycloudflare.com) in your browser.

Troubleshooting

Session code not working

  • Codes are case-insensitive
  • Ensure the Mac client is still connected to the relay (check menu bar status)
  • Restart the Mac client if needed

Terminal not displaying output

  1. Check that the pty-proxy is running: pgrep pty-proxy
  2. Check the Mac client logs: log stream --predicate 'process == "mac-client"'
  3. Verify the relay server is running

Browser shows "Disconnected"

  • Check the relay server is still running
  • The connection will auto-reconnect with exponential backoff
  • Refresh the page if reconnection fails

Security notes

  • Session codes provide access control (not authentication)
  • Terminal input is passed directly to the shell (no sanitization)
  • For production use, consider adding proper authentication and TLS
  • Cloudflare Tunnel provides encrypted transport for remote access

About

IgnisTerm - Control your Mac terminal from anywhere. Minimal. Powerful.

Topics

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' GitHub - unknown-studio-dev/ignis-term: IgnisTerm - Control your Mac terminal from anywhere. Minimal. Powerful. · GitHub
Skip to content
This repository was archived by the owner on Apr 6, 2026. It is now read-only.

Repository files navigation

Terminal Remote

Access your Mac's terminal sessions from any browser, anywhere.

A menu bar app runs on your Mac, connects to a relay server, and you open the relay's web UI from any device — iPad, laptop, phone — to see and interact with your terminal sessions.

Web UI

Install

curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/install.sh | bash

That's it. Services start immediately and auto-start on login.

To install a specific version:

VERSION=v2.2.0 curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/install.sh | bash

What it does

  • Installs Homebrew dependencies (cloudflared)
  • Downloads the latest release for your architecture (Apple Silicon or Intel)
  • Installs the menu bar app, relay server, and pty-proxy to ~/.terminal-remote/
  • Installs Terminal Remote.app to ~/Applications/
  • Configures shell integration (zsh, bash, or fish)
  • Creates LaunchAgents so services auto-start on login and restart on crash

Prerequisites

  • macOS (Apple Silicon or Intel)
  • Homebrew (for installing cloudflared)

Shell integration

Add one line to your shell rc file so new terminal windows are automatically wrapped in pty-proxy and become remotely accessible:

# ~/.bashrcsource~/.terminal-remote/init.bash
# ~/.zshrcsource~/.terminal-remote/init.zsh
# ~/.config/fish/config.fishsource~/.terminal-remote/init.fish

The pty-proxy is fully transparent — scroll, copy, mouse, and all terminal features work natively. Unlike tmux-based approaches, there are no compatibility issues with your terminal emulator.

Uninstall

curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/uninstall.sh | bash

Removes the app, binaries, LaunchAgents, and shell integration.

Architecture

┌─────────────┐ WebSocket ┌──────────────┐ WebSocket ┌─────────────┐
│ Mac Client │ ◄───────────────► │ Relay Server │ ◄───────────────► │ Browser UI │
│ (menu bar) │ │ (Rust/Axum) │ │ (React) │
└──────┬──────┘ └──────────────┘ └─────────────┘
│
├── pty-proxy (transparent PTY capture per shell)
└── cloudflared (tunnel for remote access)
ComponentDirectoryLanguagePurpose
Mac Clientmac-client/RustMenu bar app, manages pty-proxy sessions, bridges to relay
PTY Proxypty-proxy/RustTransparent PTY wrapper that captures terminal I/O
Relay Serverrelay-server/RustRoutes WebSocket messages between Mac and browsers
Web UIrelay-server/web-ui/TypeScript/ReactTerminal UI with xterm.js, embedded in relay binary
Shell Integrationshell-integration/Bash/Zsh/FishAuto-wraps new shells in pty-proxy

How it works

Connection flow

  1. Mac client starts and connects to the relay server via WebSocket
  2. Relay server generates a 6-character session code
  3. Mac client displays the code in the menu bar
  4. User opens the relay URL in a browser and enters the code
  5. Relay authenticates the browser and pairs it with the Mac client
  6. Browser receives the session list and displays terminal tabs

Terminal I/O

Each shell session is wrapped in a pty-proxy process that sits between the terminal emulator and the shell. The proxy forwards all I/O transparently while sending a copy to the mac-client via Unix socket.

Terminal.app
↕ PTY (transparent)
pty-proxy
├── ↕ Shell (zsh/bash/fish)
└── → Unix socket → Mac client
→ WebSocket to relay
→ Relay broadcasts to browsers
→ xterm.js renders output

Browser input flows in reverse: xterm.js → relay → mac-client → pty-proxy → shell.

Session management

  • Shell integration wraps each new interactive shell in a pty-proxy instance
  • pty-proxy connects to the mac-client via Unix socket (/tmp/terminal-remote.sock)
  • Each proxy sends a registration message (shell, pid, tty) on connect
  • Session connect/disconnect events are broadcast to browsers as JSON control messages
  • The relay maintains a scrollback buffer (1 MB) per session, replayed on browser reconnect

Session codes

  • 6 characters from ABCDEFGHJKMNPQRSTVWXYZ23456789 (no lookalike chars)
  • Case-insensitive entry
  • Generated by the relay server using nanoid

Configuration

Environment variables

Relay Server:

PORT=3000 # Listen port (default: 3000)

Mac Client:

RELAY_URL=ws://localhost:3000/ws # Relay WebSocket URL (default)

Development

Tech stack

LayerTechnology
Mac ClientRust, Tokio, tray-icon, muda, tokio-tungstenite
PTY ProxyRust, nix (PTY/fork/poll), Unix sockets
Relay ServerRust, Axum, Tokio, rust-embed, DashMap
Web UIReact 19, TypeScript 5, Vite 6, xterm.js 6, Zod
Infrastructurecloudflared, Homebrew, LaunchAgents

Building

# Mac client
cargo build -p mac-client
# PTY proxy
cargo build -p pty-proxy
# Relay server (build web UI first)cd relay-server/web-ui && pnpm build
cargo build -p relay-server
# Web UI onlycd relay-server/web-ui && pnpm build

Running locally

# Terminal 1: Relay server
cargo run -p relay-server
# Terminal 2: Mac client
cargo run -p mac-client
# Terminal 3: Web UI dev server (optional, for HMR)cd relay-server/web-ui && pnpm dev

Access via http://localhost:5173 (Vite dev) or http://localhost:3000 (relay with embedded UI).

Testing

cargo test -p mac-client
cargo test -p relay-server

Project structure

ignis-term/
├── mac-client/ # Rust menu bar application
│ └── src/
│ ├── main.rs # Entry point, event loop, menu
│ ├── app.rs # App state, event types
│ ├── protocol.rs # Control message serialization
│ ├── relay/ # WebSocket client with auto-reconnect
│ └── pty/mod.rs # PTY proxy session management
│
├── pty-proxy/ # Transparent PTY wrapper
│ └── src/
│ └── main.rs # PTY fork, I/O forwarding, Unix socket
│
├── relay-server/ # Rust relay server
│ ├── src/
│ │ ├── main.rs # Axum server setup
│ │ ├── state.rs # Session state, scrollback buffer
│ │ ├── protocol.rs # Control message enum
│ │ ├── session.rs # Session code generation
│ │ └── handlers/ws.rs # WebSocket handler (mac + browser)
│ │
│ ├── web-ui/ # React web application
│ │ └── src/
│ │ ├── App.tsx
│ │ ├── routes/ # LoginPage, TerminalPage
│ │ ├── lib/context/ # Connection, Terminal, Tabs contexts
│ │ ├── lib/components/ # Terminal, TerminalTabs, etc.
│ │ └── shared/ # Constants, protocol schemas
│ │
│ └── assets/ # Built web UI (embedded in binary)
│
├── shell-integration/ # Shell init scripts (bash/zsh/fish)
└── scripts/ # install.sh, uninstall.sh

Remote access with Cloudflare Tunnel

The Mac client automatically spawns cloudflared to create a tunnel, providing a public HTTPS URL displayed in the menu bar. No manual tunnel setup required.

For manual tunnel creation:

# Start relay server
cargo run -p relay-server &# Create a quick tunnel
cloudflared tunnel --url http://localhost:3000

Use the generated URL (e.g., https://random-words.trycloudflare.com) in your browser.

Troubleshooting

Session code not working

  • Codes are case-insensitive
  • Ensure the Mac client is still connected to the relay (check menu bar status)
  • Restart the Mac client if needed

Terminal not displaying output

  1. Check that the pty-proxy is running: pgrep pty-proxy
  2. Check the Mac client logs: log stream --predicate 'process == "mac-client"'
  3. Verify the relay server is running

Browser shows "Disconnected"

  • Check the relay server is still running
  • The connection will auto-reconnect with exponential backoff
  • Refresh the page if reconnection fails

Security notes

  • Session codes provide access control (not authentication)
  • Terminal input is passed directly to the shell (no sanitization)
  • For production use, consider adding proper authentication and TLS
  • Cloudflare Tunnel provides encrypted transport for remote access

About

IgnisTerm - Control your Mac terminal from anywhere. Minimal. Powerful.

Topics

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' GitHub - unknown-studio-dev/ignis-term: IgnisTerm - Control your Mac terminal from anywhere. Minimal. Powerful. · GitHub
Skip to content
This repository was archived by the owner on Apr 6, 2026. It is now read-only.

Repository files navigation

Terminal Remote

Access your Mac's terminal sessions from any browser, anywhere.

A menu bar app runs on your Mac, connects to a relay server, and you open the relay's web UI from any device — iPad, laptop, phone — to see and interact with your terminal sessions.

Web UI

Install

curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/install.sh | bash

That's it. Services start immediately and auto-start on login.

To install a specific version:

VERSION=v2.2.0 curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/install.sh | bash

What it does

  • Installs Homebrew dependencies (cloudflared)
  • Downloads the latest release for your architecture (Apple Silicon or Intel)
  • Installs the menu bar app, relay server, and pty-proxy to ~/.terminal-remote/
  • Installs Terminal Remote.app to ~/Applications/
  • Configures shell integration (zsh, bash, or fish)
  • Creates LaunchAgents so services auto-start on login and restart on crash

Prerequisites

  • macOS (Apple Silicon or Intel)
  • Homebrew (for installing cloudflared)

Shell integration

Add one line to your shell rc file so new terminal windows are automatically wrapped in pty-proxy and become remotely accessible:

# ~/.bashrcsource~/.terminal-remote/init.bash
# ~/.zshrcsource~/.terminal-remote/init.zsh
# ~/.config/fish/config.fishsource~/.terminal-remote/init.fish

The pty-proxy is fully transparent — scroll, copy, mouse, and all terminal features work natively. Unlike tmux-based approaches, there are no compatibility issues with your terminal emulator.

Uninstall

curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/uninstall.sh | bash

Removes the app, binaries, LaunchAgents, and shell integration.

Architecture

┌─────────────┐ WebSocket ┌──────────────┐ WebSocket ┌─────────────┐
│ Mac Client │ ◄───────────────► │ Relay Server │ ◄───────────────► │ Browser UI │
│ (menu bar) │ │ (Rust/Axum) │ │ (React) │
└──────┬──────┘ └──────────────┘ └─────────────┘
│
├── pty-proxy (transparent PTY capture per shell)
└── cloudflared (tunnel for remote access)
ComponentDirectoryLanguagePurpose
Mac Clientmac-client/RustMenu bar app, manages pty-proxy sessions, bridges to relay
PTY Proxypty-proxy/RustTransparent PTY wrapper that captures terminal I/O
Relay Serverrelay-server/RustRoutes WebSocket messages between Mac and browsers
Web UIrelay-server/web-ui/TypeScript/ReactTerminal UI with xterm.js, embedded in relay binary
Shell Integrationshell-integration/Bash/Zsh/FishAuto-wraps new shells in pty-proxy

How it works

Connection flow

  1. Mac client starts and connects to the relay server via WebSocket
  2. Relay server generates a 6-character session code
  3. Mac client displays the code in the menu bar
  4. User opens the relay URL in a browser and enters the code
  5. Relay authenticates the browser and pairs it with the Mac client
  6. Browser receives the session list and displays terminal tabs

Terminal I/O

Each shell session is wrapped in a pty-proxy process that sits between the terminal emulator and the shell. The proxy forwards all I/O transparently while sending a copy to the mac-client via Unix socket.

Terminal.app
↕ PTY (transparent)
pty-proxy
├── ↕ Shell (zsh/bash/fish)
└── → Unix socket → Mac client
→ WebSocket to relay
→ Relay broadcasts to browsers
→ xterm.js renders output

Browser input flows in reverse: xterm.js → relay → mac-client → pty-proxy → shell.

Session management

  • Shell integration wraps each new interactive shell in a pty-proxy instance
  • pty-proxy connects to the mac-client via Unix socket (/tmp/terminal-remote.sock)
  • Each proxy sends a registration message (shell, pid, tty) on connect
  • Session connect/disconnect events are broadcast to browsers as JSON control messages
  • The relay maintains a scrollback buffer (1 MB) per session, replayed on browser reconnect

Session codes

  • 6 characters from ABCDEFGHJKMNPQRSTVWXYZ23456789 (no lookalike chars)
  • Case-insensitive entry
  • Generated by the relay server using nanoid

Configuration

Environment variables

Relay Server:

PORT=3000 # Listen port (default: 3000)

Mac Client:

RELAY_URL=ws://localhost:3000/ws # Relay WebSocket URL (default)

Development

Tech stack

LayerTechnology
Mac ClientRust, Tokio, tray-icon, muda, tokio-tungstenite
PTY ProxyRust, nix (PTY/fork/poll), Unix sockets
Relay ServerRust, Axum, Tokio, rust-embed, DashMap
Web UIReact 19, TypeScript 5, Vite 6, xterm.js 6, Zod
Infrastructurecloudflared, Homebrew, LaunchAgents

Building

# Mac client
cargo build -p mac-client
# PTY proxy
cargo build -p pty-proxy
# Relay server (build web UI first)cd relay-server/web-ui && pnpm build
cargo build -p relay-server
# Web UI onlycd relay-server/web-ui && pnpm build

Running locally

# Terminal 1: Relay server
cargo run -p relay-server
# Terminal 2: Mac client
cargo run -p mac-client
# Terminal 3: Web UI dev server (optional, for HMR)cd relay-server/web-ui && pnpm dev

Access via http://localhost:5173 (Vite dev) or http://localhost:3000 (relay with embedded UI).

Testing

cargo test -p mac-client
cargo test -p relay-server

Project structure

ignis-term/
├── mac-client/ # Rust menu bar application
│ └── src/
│ ├── main.rs # Entry point, event loop, menu
│ ├── app.rs # App state, event types
│ ├── protocol.rs # Control message serialization
│ ├── relay/ # WebSocket client with auto-reconnect
│ └── pty/mod.rs # PTY proxy session management
│
├── pty-proxy/ # Transparent PTY wrapper
│ └── src/
│ └── main.rs # PTY fork, I/O forwarding, Unix socket
│
├── relay-server/ # Rust relay server
│ ├── src/
│ │ ├── main.rs # Axum server setup
│ │ ├── state.rs # Session state, scrollback buffer
│ │ ├── protocol.rs # Control message enum
│ │ ├── session.rs # Session code generation
│ │ └── handlers/ws.rs # WebSocket handler (mac + browser)
│ │
│ ├── web-ui/ # React web application
│ │ └── src/
│ │ ├── App.tsx
│ │ ├── routes/ # LoginPage, TerminalPage
│ │ ├── lib/context/ # Connection, Terminal, Tabs contexts
│ │ ├── lib/components/ # Terminal, TerminalTabs, etc.
│ │ └── shared/ # Constants, protocol schemas
│ │
│ └── assets/ # Built web UI (embedded in binary)
│
├── shell-integration/ # Shell init scripts (bash/zsh/fish)
└── scripts/ # install.sh, uninstall.sh

Remote access with Cloudflare Tunnel

The Mac client automatically spawns cloudflared to create a tunnel, providing a public HTTPS URL displayed in the menu bar. No manual tunnel setup required.

For manual tunnel creation:

# Start relay server
cargo run -p relay-server &# Create a quick tunnel
cloudflared tunnel --url http://localhost:3000

Use the generated URL (e.g., https://random-words.trycloudflare.com) in your browser.

Troubleshooting

Session code not working

  • Codes are case-insensitive
  • Ensure the Mac client is still connected to the relay (check menu bar status)
  • Restart the Mac client if needed

Terminal not displaying output

  1. Check that the pty-proxy is running: pgrep pty-proxy
  2. Check the Mac client logs: log stream --predicate 'process == "mac-client"'
  3. Verify the relay server is running

Browser shows "Disconnected"

  • Check the relay server is still running
  • The connection will auto-reconnect with exponential backoff
  • Refresh the page if reconnection fails

Security notes

  • Session codes provide access control (not authentication)
  • Terminal input is passed directly to the shell (no sanitization)
  • For production use, consider adding proper authentication and TLS
  • Cloudflare Tunnel provides encrypted transport for remote access

About

IgnisTerm - Control your Mac terminal from anywhere. Minimal. Powerful.

Topics

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); GitHub - unknown-studio-dev/ignis-term: IgnisTerm - Control your Mac terminal from anywhere. Minimal. Powerful. · GitHub
Skip to content
This repository was archived by the owner on Apr 6, 2026. It is now read-only.

Repository files navigation

Terminal Remote

Access your Mac's terminal sessions from any browser, anywhere.

A menu bar app runs on your Mac, connects to a relay server, and you open the relay's web UI from any device — iPad, laptop, phone — to see and interact with your terminal sessions.

Web UI

Install

curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/install.sh | bash

That's it. Services start immediately and auto-start on login.

To install a specific version:

VERSION=v2.2.0 curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/install.sh | bash

What it does

  • Installs Homebrew dependencies (cloudflared)
  • Downloads the latest release for your architecture (Apple Silicon or Intel)
  • Installs the menu bar app, relay server, and pty-proxy to ~/.terminal-remote/
  • Installs Terminal Remote.app to ~/Applications/
  • Configures shell integration (zsh, bash, or fish)
  • Creates LaunchAgents so services auto-start on login and restart on crash

Prerequisites

  • macOS (Apple Silicon or Intel)
  • Homebrew (for installing cloudflared)

Shell integration

Add one line to your shell rc file so new terminal windows are automatically wrapped in pty-proxy and become remotely accessible:

# ~/.bashrcsource~/.terminal-remote/init.bash
# ~/.zshrcsource~/.terminal-remote/init.zsh
# ~/.config/fish/config.fishsource~/.terminal-remote/init.fish

The pty-proxy is fully transparent — scroll, copy, mouse, and all terminal features work natively. Unlike tmux-based approaches, there are no compatibility issues with your terminal emulator.

Uninstall

curl -fsSL https://raw.githubusercontent.com/studium-ignotum/ignis-term/master/scripts/uninstall.sh | bash

Removes the app, binaries, LaunchAgents, and shell integration.

Architecture

┌─────────────┐ WebSocket ┌──────────────┐ WebSocket ┌─────────────┐
│ Mac Client │ ◄───────────────► │ Relay Server │ ◄───────────────► │ Browser UI │
│ (menu bar) │ │ (Rust/Axum) │ │ (React) │
└──────┬──────┘ └──────────────┘ └─────────────┘
│
├── pty-proxy (transparent PTY capture per shell)
└── cloudflared (tunnel for remote access)
ComponentDirectoryLanguagePurpose
Mac Clientmac-client/RustMenu bar app, manages pty-proxy sessions, bridges to relay
PTY Proxypty-proxy/RustTransparent PTY wrapper that captures terminal I/O
Relay Serverrelay-server/RustRoutes WebSocket messages between Mac and browsers
Web UIrelay-server/web-ui/TypeScript/ReactTerminal UI with xterm.js, embedded in relay binary
Shell Integrationshell-integration/Bash/Zsh/FishAuto-wraps new shells in pty-proxy

How it works

Connection flow

  1. Mac client starts and connects to the relay server via WebSocket
  2. Relay server generates a 6-character session code
  3. Mac client displays the code in the menu bar
  4. User opens the relay URL in a browser and enters the code
  5. Relay authenticates the browser and pairs it with the Mac client
  6. Browser receives the session list and displays terminal tabs

Terminal I/O

Each shell session is wrapped in a pty-proxy process that sits between the terminal emulator and the shell. The proxy forwards all I/O transparently while sending a copy to the mac-client via Unix socket.

Terminal.app
↕ PTY (transparent)
pty-proxy
├── ↕ Shell (zsh/bash/fish)
└── → Unix socket → Mac client
→ WebSocket to relay
→ Relay broadcasts to browsers
→ xterm.js renders output

Browser input flows in reverse: xterm.js → relay → mac-client → pty-proxy → shell.

Session management

  • Shell integration wraps each new interactive shell in a pty-proxy instance
  • pty-proxy connects to the mac-client via Unix socket (/tmp/terminal-remote.sock)
  • Each proxy sends a registration message (shell, pid, tty) on connect
  • Session connect/disconnect events are broadcast to browsers as JSON control messages
  • The relay maintains a scrollback buffer (1 MB) per session, replayed on browser reconnect

Session codes

  • 6 characters from ABCDEFGHJKMNPQRSTVWXYZ23456789 (no lookalike chars)
  • Case-insensitive entry
  • Generated by the relay server using nanoid

Configuration

Environment variables

Relay Server:

PORT=3000 # Listen port (default: 3000)

Mac Client:

RELAY_URL=ws://localhost:3000/ws # Relay WebSocket URL (default)

Development

Tech stack

LayerTechnology
Mac ClientRust, Tokio, tray-icon, muda, tokio-tungstenite
PTY ProxyRust, nix (PTY/fork/poll), Unix sockets
Relay ServerRust, Axum, Tokio, rust-embed, DashMap
Web UIReact 19, TypeScript 5, Vite 6, xterm.js 6, Zod
Infrastructurecloudflared, Homebrew, LaunchAgents

Building

# Mac client
cargo build -p mac-client
# PTY proxy
cargo build -p pty-proxy
# Relay server (build web UI first)cd relay-server/web-ui && pnpm build
cargo build -p relay-server
# Web UI onlycd relay-server/web-ui && pnpm build

Running locally

# Terminal 1: Relay server
cargo run -p relay-server
# Terminal 2: Mac client
cargo run -p mac-client
# Terminal 3: Web UI dev server (optional, for HMR)cd relay-server/web-ui && pnpm dev

Access via http://localhost:5173 (Vite dev) or http://localhost:3000 (relay with embedded UI).

Testing

cargo test -p mac-client
cargo test -p relay-server

Project structure

ignis-term/
├── mac-client/ # Rust menu bar application
│ └── src/
│ ├── main.rs # Entry point, event loop, menu
│ ├── app.rs # App state, event types
│ ├── protocol.rs # Control message serialization
│ ├── relay/ # WebSocket client with auto-reconnect
│ └── pty/mod.rs # PTY proxy session management
│
├── pty-proxy/ # Transparent PTY wrapper
│ └── src/
│ └── main.rs # PTY fork, I/O forwarding, Unix socket
│
├── relay-server/ # Rust relay server
│ ├── src/
│ │ ├── main.rs # Axum server setup
│ │ ├── state.rs # Session state, scrollback buffer
│ │ ├── protocol.rs # Control message enum
│ │ ├── session.rs # Session code generation
│ │ └── handlers/ws.rs # WebSocket handler (mac + browser)
│ │
│ ├── web-ui/ # React web application
│ │ └── src/
│ │ ├── App.tsx
│ │ ├── routes/ # LoginPage, TerminalPage
│ │ ├── lib/context/ # Connection, Terminal, Tabs contexts
│ │ ├── lib/components/ # Terminal, TerminalTabs, etc.
│ │ └── shared/ # Constants, protocol schemas
│ │
│ └── assets/ # Built web UI (embedded in binary)
│
├── shell-integration/ # Shell init scripts (bash/zsh/fish)
└── scripts/ # install.sh, uninstall.sh

Remote access with Cloudflare Tunnel

The Mac client automatically spawns cloudflared to create a tunnel, providing a public HTTPS URL displayed in the menu bar. No manual tunnel setup required.

For manual tunnel creation:

# Start relay server
cargo run -p relay-server &# Create a quick tunnel
cloudflared tunnel --url http://localhost:3000

Use the generated URL (e.g., https://random-words.trycloudflare.com) in your browser.

Troubleshooting

Session code not working

  • Codes are case-insensitive
  • Ensure the Mac client is still connected to the relay (check menu bar status)
  • Restart the Mac client if needed

Terminal not displaying output

  1. Check that the pty-proxy is running: pgrep pty-proxy
  2. Check the Mac client logs: log stream --predicate 'process == "mac-client"'
  3. Verify the relay server is running

Browser shows "Disconnected"

  • Check the relay server is still running
  • The connection will auto-reconnect with exponential backoff
  • Refresh the page if reconnection fails

Security notes

  • Session codes provide access control (not authentication)
  • Terminal input is passed directly to the shell (no sanitization)
  • For production use, consider adding proper authentication and TLS
  • Cloudflare Tunnel provides encrypted transport for remote access

About

IgnisTerm - Control your Mac terminal from anywhere. Minimal. Powerful.

Topics

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages