Skip to content

A lightweight terminal interface allowing users to access their computers remotely via WebSocket

Notifications You must be signed in to change notification settings

Warkanlock/microterminal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

microterminal

microterminal is a toy-like project that acts as a lightweight HTML terminal interface that allows users to access their computer remotely via WebSocket. It supports a limited set of system commands within a sandbox directory, providing a secure and minimalist command-line experience.

demo.mp4

Features

  • Remote Access: Interact with your computer's terminal through a WebSocket interface.
  • Command Limiting: Only a predefined set of commands is available for execution.
  • Sandboxed Directory: File operations are isolated within a unique temporary directory to prevent unauthorized file access.
  • Process Control: Start, stop, or kill processes initiated within the session.

Getting Started

  1. Clone the repository and install dependencies.
  2. Set up environment (optional):
export PORT=3000  # Default port is 3000
  1. Run the server:
npm start

Usage

  • Open index.html in your browser.
  • This will establish a WebSocket connection to your server (default port: ws://localhost:3000).
  • Execute Commands

Client-side Commands

  • View Available Commands: help
  • Stop a Running Command: stop or kill
  • To disconnect from actual session: exit

Server Commands

  • Basic: ls, pwd, cat, echo, date, whoami, ps
  • Directory management: mkdir, cd
  • Network commands: ping, dig, host, nslookup, ifconfig
  • File management: head, tail

Security

microterminal runs each session in a separate temporary directory, with command access limited to a list of safe commands to protect system integrity. However, it's not my responsibility to ensure the security of your system. Use this tool at your own risk locally or in a controlled environment.

About

A lightweight terminal interface allowing users to access their computers remotely via WebSocket

Topics

Resources

Stars

Watchers

Forks