{"id":21810909,"url":"https://github.com/vshymanskyy/serial-server","last_synced_at":"2025-04-13T22:11:54.946Z","repository":{"id":145665170,"uuid":"169175361","full_name":"vshymanskyy/serial-server","owner":"vshymanskyy","description":"Simple serial port server","archived":false,"fork":false,"pushed_at":"2019-02-08T00:52:50.000Z","size":106,"stargazers_count":27,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-13T22:11:43.428Z","etag":null,"topics":["arduino","mbed","pty","remote-shell","serialport","xterm"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vshymanskyy.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":"2019-02-05T01:22:50.000Z","updated_at":"2024-10-04T11:11:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"647da8da-10a8-4143-bf1c-35f1346e39db","html_url":"https://github.com/vshymanskyy/serial-server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vshymanskyy%2Fserial-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vshymanskyy%2Fserial-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vshymanskyy%2Fserial-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vshymanskyy%2Fserial-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vshymanskyy","download_url":"https://codeload.github.com/vshymanskyy/serial-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248788917,"owners_count":21161728,"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","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":["arduino","mbed","pty","remote-shell","serialport","xterm"],"created_at":"2024-11-27T13:38:41.022Z","updated_at":"2025-04-13T22:11:54.922Z","avatar_url":"https://github.com/vshymanskyy.png","language":"JavaScript","readme":"This tool allows you to share/access your serial terminal over the internet.  \nBased on [xterm.js](https://xtermjs.org/), [localtunnel](https://localtunnel.me).\n\n**Works on:** \n\u003cimg src=\"https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/linux.svg\" width=\"18\" height=\"18\" /\u003e Linux,\n\u003cimg src=\"https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/windows.svg\" width=\"18\" height=\"18\" /\u003e Windows,\n\u003cimg src=\"https://cdn.rawgit.com/simple-icons/simple-icons/develop/icons/apple.svg\" width=\"18\" height=\"18\" /\u003e MacOS\n\n**Features:**\n- Automatic tunneling from local machine to a public-accessible link\n- Multi-user access\n- Simple password-based authentication (with multiple credentials)\n- Read-only access for specific users\n- ANSI escape codes support: colors, mouse, window resize, window title\n- **Bonus:** share your OS shell. Just specify `shell` instead of serial port\n\n## Example\n\n```sh\n$ serial-server /dev/ttyACM0 --baud=115200 --auth=vova:MyPaSS --tunnel=vsh-device01\nServer listening on 0.0.0.0:5123\nPreparing your tunnel...\nOpened port /dev/ttyACM0,115200\nTunnel link: https://vsh-device01.localtunnel.me\n```\nVisit the provided tunnel link. It will ask for the password, then present you with a remote terminal:\n\n![examples](/docs/example_browser.png)\n\n## Installation\n\n```sh\nnpm i -g https://github.com/vshymanskyy/serial-server.git\n```\n\n## Usage\n\n```log\nserial-server \u003cport\u003e [options]\n\nOptions:\n  --version               Show version number                                              [boolean]\n  --bind, --addr          Server endpoint address                          [default: \"0.0.0.0:5123\"]\n  --baudRate, -b, --baud                                                  [number] [default: 115200]\n  --dataBits                                                      [choices: 8, 7, 6, 5] [default: 8]\n  --stopBits                                                            [choices: 1, 2] [default: 1]\n  --parity                       [choices: \"none\", \"even\", \"mark\", \"odd\", \"space\"] [default: \"none\"]\n  --auth                  Password protection. Can add multiple users (user:pass)            [array]\n  --readonly, --ro        List of users with readonly access (comma-separated)\n  --tunnel                Create tunnel link automatically                                  [string]\n  --config                Path to JSON config file\n  -h, --help              Show help                                                        [boolean]\n\nCopyright 2019 Volodymyr Shymanskyy\n```\n\n## More examples\nStart OS shell server, allow multiple guests to connect with read-only access:\n```sh\n$ serial-server shell --auth=vova:MyPaSS --auth=guest --readonly=guest --tunnel=vsh-shell\n```\n\nNon-authenticated access is always provided in read-only mode:\n```sh\n$ serial-server /dev/ttyACM0 --tunnel=vsh-device01\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvshymanskyy%2Fserial-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvshymanskyy%2Fserial-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvshymanskyy%2Fserial-server/lists"}