Registry / devops / terminal-expose

terminal-expose

library1.3.1jsnpmunverified

Terminal Expose is an interactive terminal sharing tool that starts a real shell or command on your machine and exposes it over HTTP and WebSocket for trusted collaborators to connect via browser or CLI. Version 1.3.1 is the latest stable release with a moderate release cadence. Key differentiators include token-based authentication, LAN URL generation, optional Cloudflare Quick Tunnel for public HTTPS access, PTY resize for remote clients, and an in-memory buffer for replaying recent output. It requires Node.js >=18 and provides both a server package and a separate CLI client package (terminal-expose-cli).

devops messaging

npm install terminal-expose

package ↗

INSTALL

IMPORT

SIG · TERMINAL-EXPOSE

terminal-expose

devopsjavascriptv1.3.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

terminal-expose CLI

✓ npx terminal-expose

✗ terminal-expose (without npx if globally installed)

Install globally with npm install -g terminal-expose or use npx terminal-expose. For CLI client, use terminal-expose-cli.

Global install and start exposing the default shell. Access via the printed session URLs.

npm install -g terminal-expose terminal-expose

Debug

Known issues

gotchaSession URLs give full read/write access to the terminal. Anyone with the URL can view and type.

fix

Share the full session URL only with trusted collaborators. Use SESSION_TOKEN environment variable to set a custom token.

affects: >=1.0.0

gotchaPublic tunnel mode (--public) exposes the terminal to the internet via Cloudflare. This bypasses local network restrictions but also exposes the session to any URL holder.

fix

Only use --public when absolutely necessary. Ensure SESSION_TOKEN is set to a strong secret.

affects: >=1.0.0

breakingNode.js version requirement: engine node >=18. Running on older Node versions will fail.

fix

Upgrade Node.js to >=18.

affects: >=1.3.0

Errors

Common errors & fixes

Error: Cannot find module 'terminal-expose'

Package not installed globally or locally

fix

Run 'npm install -g terminal-expose' to install globally.

Error: listen EADDRINUSE: address already in use :::5555

Port 5555 is already occupied by another process

fix

Use a different port via PORT environment variable, e.g., PORT=4000 terminal-expose

Upgrade

Version history

1.3.1latest on npm

Audit

Dependencies

terminal-expose-clioptionalRequired to connect to a terminal-expose session from another terminal

Agent activity

33 hits · last 30 days

node

OpenAI (training)

Resources

packageterminal-expose ↗