{"id":15641637,"url":"https://github.com/eddymens/interactive-terminal","last_synced_at":"2025-10-11T12:07:35.849Z","repository":{"id":163220287,"uuid":"525447417","full_name":"EDDYMENS/interactive-terminal","owner":"EDDYMENS","description":"An interactive terminal that runs in the browser using WebSockets, built with Node.js and xterm.js.","archived":false,"fork":false,"pushed_at":"2024-10-14T06:54:52.000Z","size":18,"stargazers_count":81,"open_issues_count":0,"forks_count":31,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-08-22T10:41:02.461Z","etag":null,"topics":["node-pty","nodejs","terminal-emulator","websocket","xterm-js"],"latest_commit_sha":null,"homepage":"https://www.eddymens.com/blog/creating-a-browser-based-interactive-terminal-using-xtermjs-and-nodejs","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EDDYMENS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-16T15:52:45.000Z","updated_at":"2025-06-13T04:37:09.000Z","dependencies_parsed_at":"2024-01-16T09:09:36.953Z","dependency_job_id":"bb273da0-17b7-4327-8ba3-f4d7961f3e16","html_url":"https://github.com/EDDYMENS/interactive-terminal","commit_stats":{"total_commits":17,"total_committers":1,"mean_commits":17.0,"dds":0.0,"last_synced_commit":"404db7d8c57e28e18af80dd44ed87d35abcf141e"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/EDDYMENS/interactive-terminal","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EDDYMENS%2Finteractive-terminal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EDDYMENS%2Finteractive-terminal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EDDYMENS%2Finteractive-terminal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EDDYMENS%2Finteractive-terminal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EDDYMENS","download_url":"https://codeload.github.com/EDDYMENS/interactive-terminal/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EDDYMENS%2Finteractive-terminal/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279007132,"owners_count":26084246,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["node-pty","nodejs","terminal-emulator","websocket","xterm-js"],"created_at":"2024-10-03T11:44:09.785Z","updated_at":"2025-10-11T12:07:35.797Z","avatar_url":"https://github.com/EDDYMENS.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Interactive Web-Based Terminal\n\nAn interactive terminal that runs in the browser using WebSockets, built with Node.js and xterm.js.\n\n## Features\n- Real-time terminal interaction via WebSockets.\n- Supports full terminal interactivity (e.g., Vim, Nano).\n- Options for shared or individual terminal sessions.\n\n## Requirements\n- Node.js - v16 or higher.\n- NPM\n\n## Setup Process\n\nThe project consists of two parts, the **backend** (Node.js server) and the **frontend** (xterm.js terminal interface), just like a typical web application.\n\n### Project Setup\n\n1. Clone this repository:\n   ```bash\n   git clone https://github.com/EDDYMENS/interactive-terminal.git\n   ```\n\n2. Navigate to the project directory:\n   ```bash\n   cd interactive-terminal\n   ```\n\n3. Install dependencies:\n   ```bash\n   npm install\n   ```\n\n4. Start the server:\n   ```bash\n   npm run start\n   ```\n\n5. The demo runs on port `6060` by default. You can modify this by editing the port number in the configuration section of the `/src/server.js` file.\n\n### Frontend\nThe frontend automatically loads in your browser at `http://localhost:6060` when the server starts. The client-side code is located in `/src/client.js`.\n\n## Customization\n\n- **Port Configuration**: To change the default port, update the port number in the `/src/server.js` file.\n- **Shared or Individual Sessions**: The terminal can either run as a shared session for all users or create an individual session per user. This can be configured by setting the boolean value of `setSharedTerminalMode(false);` in `server.js`.\n\n## Documentation \u0026 Tutorial\n\nFor a detailed breakdown of how the different parts of this code work and how to extend the functionality, refer to the [complete tutorial](https://www.eddymens.com/blog/creating-a-browser-based-interactive-terminal-using-xtermjs-and-nodejs) on [Eddymens.com](https://www.eddymens.com).\n\n## Changelog\n\n### [v2](https://github.com/EDDYMENS/interactive-terminal/tree/v2)\n- Introduced the option for both shared and individualized sessions.\n- Cosmetic changes and restructuring of the demo code.\n\n### [v1](https://github.com/EDDYMENS/interactive-terminal/tree/v1)\n- Added support for copy-pasting in the terminal.\n- Enabled full terminal interactivity (e.g., Vim support).\n- Initial release.\n\n## License\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feddymens%2Finteractive-terminal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feddymens%2Finteractive-terminal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feddymens%2Finteractive-terminal/lists"}