{"id":45855843,"url":"https://github.com/dorlugasigal/termbeam","last_synced_at":"2026-05-03T19:05:15.332Z","repository":{"id":340873867,"uuid":"1167942880","full_name":"dorlugasigal/TermBeam","owner":"dorlugasigal","description":"Beam your terminal to any device — mobile-optimized web terminal with multi-session support","archived":false,"fork":false,"pushed_at":"2026-05-01T07:02:24.000Z","size":51139,"stargazers_count":33,"open_issues_count":2,"forks_count":3,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-01T07:12:00.971Z","etag":null,"topics":["cli","developer-tools","devtools","mobile","nodejs","pty","remote-access","terminal","web-terminal","websocket","xterm"],"latest_commit_sha":null,"homepage":"https://termbeam.pages.dev","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/dorlugasigal.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"dorlugasigal"}},"created_at":"2026-02-26T21:13:36.000Z","updated_at":"2026-05-01T07:02:27.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/dorlugasigal/TermBeam","commit_stats":null,"previous_names":["dorlugasigal/termbeam"],"tags_count":117,"template":false,"template_full_name":null,"purl":"pkg:github/dorlugasigal/TermBeam","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dorlugasigal%2FTermBeam","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dorlugasigal%2FTermBeam/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dorlugasigal%2FTermBeam/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dorlugasigal%2FTermBeam/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dorlugasigal","download_url":"https://codeload.github.com/dorlugasigal/TermBeam/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dorlugasigal%2FTermBeam/sbom","scorecard":{"id":1244419,"data":{"date":"2026-03-05T23:12:26Z","repo":{"name":"github.com/dorlugasigal/TermBeam","commit":"9af0085672a8d49d089438e50643260ac22e8e4c"},"scorecard":{"version":"v5.3.0","commit":"c22063e786c11f9dd714d777a687ff7c4599b600"},"score":6.1,"checks":[{"name":"Maintained","score":0,"reason":"project was created within the last 90 days. Please review its contents carefully","details":["Warn: Repository was created within the last 90 days."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 0/24 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#code-review"}},{"name":"Dependency-Update-Tool","score":10,"reason":"update tool detected","details":["Info: detected update tool: Dependabot: .github/dependabot.yml:1"],"documentation":{"short":"Determines if the project uses a dependency update tool.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#dependency-update-tool"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: jobLevel 'contents' permission set to 'write': .github/workflows/ci.yml:35","Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:19","Info: jobLevel 'contents' permission set to 'read': .github/workflows/landing.yml:20","Warn: jobLevel 'deployments' permission set to 'write': .github/workflows/landing.yml:21","Info: jobLevel 'contents' permission set to 'read': .github/workflows/scorecard.yml:18","Info: jobLevel 'actions' permission set to 'read': .github/workflows/scorecard.yml:19","Info: topLevel 'contents' permission set to 'read': .github/workflows/ci.yml:10","Info: topLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:12","Info: topLevel 'contents' permission set to 'read': .github/workflows/landing.yml:11","Info: topLevel 'contents' permission set to 'read': .github/workflows/pages.yml:11","Warn: topLevel 'contents' permission set to 'write': .github/workflows/release.yml:21","Info: topLevel 'contents' permission set to 'read': .github/workflows/scorecard.yml:10","Info: topLevel 'actions' permission set to 'read': .github/workflows/scorecard.yml:11","Info: topLevel 'contents' permission set to 'read': .github/workflows/security.yml:10","Info: topLevel 'contents' permission set to 'read': .github/workflows/smoke.yml:10"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#dangerous-workflow"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Info: Found linked content: SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1","Info: Found text in security policy: SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#security-policy"}},{"name":"Pinned-Dependencies","score":9,"reason":"dependency not pinned by hash detected -- score normalized to 9","details":["Warn: pipCommand not pinned by hash: .github/workflows/pages.yml:31","Warn: npmCommand not pinned by hash: .github/workflows/smoke.yml:33","Info:  32 out of  32 GitHub-owned GitHubAction dependencies pinned","Info:   7 out of   7 third-party GitHubAction dependencies pinned","Info:   0 out of   1 pipCommand dependencies pinned","Info:   1 out of   1 containerImage dependencies pinned","Info:   9 out of  10 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#cii-best-practices"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#signed-releases"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":9,"reason":"SAST tool detected but not run on all commits","details":["Info: SAST configuration detected: CodeQL","Warn: 19 commits out of 21 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#sast"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#license"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/release.yml:25"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#packaging"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#fuzzing"}},{"name":"Branch-Protection","score":3,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'main'","Info: 'force pushes' disabled on branch 'main'","Warn: 'branch protection settings apply to administrators' is disabled on branch 'main'","Warn: 'stale review dismissal' is disabled on branch 'main'","Warn: branch 'main' does not require approvers","Warn: codeowners review is not required on branch 'main'","Warn: 'last push approval' is disabled on branch 'main'","Warn: 'up-to-date branches' is disabled on branch 'main'","Info: status check found to merge onto on branch 'main'","Info: PRs are required in order to make changes on branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#branch-protection"}},{"name":"Contributors","score":3,"reason":"project has 1 contributing companies or organizations -- score normalized to 3","details":["Info: found contributions from: microsoft"],"documentation":{"short":"Determines if the project has a set of contributors from multiple organizations (e.g., companies).","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#contributors"}},{"name":"CI-Tests","score":10,"reason":"20 out of 20 merged PRs checked by a CI test -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project runs tests before pull requests are merged.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#ci-tests"}}]},"last_synced_at":"2026-03-06T03:41:11.495Z","repository_id":340873867,"created_at":"2026-03-06T03:41:11.495Z","updated_at":"2026-03-06T03:41:11.495Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32581051,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T06:36:36.687Z","status":"ssl_error","status_checked_at":"2026-05-03T06:36:09.306Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["cli","developer-tools","devtools","mobile","nodejs","pty","remote-access","terminal","web-terminal","websocket","xterm"],"created_at":"2026-02-27T04:05:34.003Z","updated_at":"2026-05-03T19:05:15.326Z","avatar_url":"https://github.com/dorlugasigal.png","language":"JavaScript","funding_links":["https://github.com/sponsors/dorlugasigal"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# TermBeam\n\n**Beam your terminal to any device.**\n\n[![npm version](https://img.shields.io/npm/v/termbeam.svg)](https://www.npmjs.com/package/termbeam)\n[![npm downloads](https://img.shields.io/npm/dm/termbeam.svg)](https://www.npmjs.com/package/termbeam)\n[![CI](https://github.com/dorlugasigal/TermBeam/actions/workflows/ci.yml/badge.svg)](https://github.com/dorlugasigal/TermBeam/actions/workflows/ci.yml)\n[![Coverage](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/dorlugasigal/TermBeam/coverage-data/endpoint.json)](https://github.com/dorlugasigal/TermBeam/actions/workflows/ci.yml)\n[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/dorlugasigal/TermBeam/badge)](https://securityscorecards.dev/viewer/?uri=github.com/dorlugasigal/TermBeam)\n[![Node.js](https://img.shields.io/node/v/termbeam.svg)](https://nodejs.org/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n\u003c/div\u003e\n\nTermBeam lets you access your terminal from a phone, tablet, or any browser — no SSH, no port forwarding, no configuration needed. Run one command and scan the QR code.\n\n[Full documentation](https://dorlugasigal.github.io/TermBeam/) · [Website](https://termbeam.pages.dev)\n\nhttps://github.com/user-attachments/assets/9dd4f3d7-f017-4314-9b3a-f6a5688e3671\n\n### Mobile UI\n\n\u003ctable align=\"center\"\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003cimg src=\"packages/site/public/mobile-session-hub.jpeg\" alt=\"Session hub on mobile\" width=\"250\" /\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003cimg src=\"packages/site/public/mobile-terminal.jpeg\" alt=\"Terminal with touch bar on mobile\" width=\"250\" /\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003cimg src=\"packages/site/public/mobile-session-preview.jpeg\" alt=\"File browser on mobile\" width=\"250\" /\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003cimg src=\"packages/site/public/mobile-command-palette.jpeg\" alt=\"Tools panel on mobile\" width=\"250\" /\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n## Quick Start\n\n```bash\nnpx termbeam\n```\n\nOr install globally:\n\n```bash\nnpm install -g termbeam\ntermbeam\n```\n\nScan the QR code printed in your terminal, or open the URL on any device.\n\n```bash\ntermbeam                        # tunnel + auto-password (default)\ntermbeam --password mysecret    # custom password\ntermbeam --no-tunnel            # LAN only\ntermbeam -i                     # interactive setup wizard\n```\n\n## Features\n\n### Mobile-First\n\n- **No SSH client needed** — just open a browser on any device\n- **Touch-optimized key bar** with arrows, Tab, Ctrl, Esc, copy, paste, and more\n- **Swipe scrolling**, pinch zoom, and text selection overlay for copy-paste\n- **iPhone PWA safe-area support** for a native-app feel\n\n### Multi-Session\n\n- **Tabbed terminals** with drag-to-reorder and live tab previews on hover/long-press\n- **Split view** — two sessions side-by-side (auto-rotates horizontal/vertical)\n- **Session colors and activity indicators** for at-a-glance status\n- **Folder browser** for picking working directory, optional initial command per session\n\n### Productivity\n\n- **Terminal search** with regex, match count, and prev/next navigation\n- **Tools panel** (Ctrl+K / Cmd+K) — slide-out sheet for quick access to all actions, organized into **Session · Files · View · Share · Agents · Settings · System**. Settings (theme, font size, defaults, haptics) are inline panels reachable from the panel; on mobile the panel slides up from the bottom, on desktop it docks to the right.\n- **Customizable Touch Bar** — 8-column, multi-row (up to 3) key grid with drag-to-reorder, collapsible drawer, and a dedicated key editor (label, send payload, action, modifier).\n- **Workspaces** — save named bundles of sessions (each with its own name, cwd, shell, color and initial command). Mark one as `default` and the **server** auto-spawns it on startup, so connecting any client lands on a ready terminal. Preferences (theme, fonts, defaults, custom keys, workspaces) are persisted server-side in `~/.termbeam/prefs.json` and sync across devices.\n- **File upload** — send files from your phone to the session's working directory\n- **File browser \u0026 download** — browse files in a session's working directory from the side panel and download them to your device\n- **Markdown viewer** — preview `.md` files rendered with GitHub Flavored Markdown directly in the browser\n- **Git changes view** — view git status, diffs, blame, and commit history in the code viewer. Toggle between Files and Changes tabs, view staged/unstaged diffs with syntax highlighting, and see per-line blame annotations\n- **Push notifications** — get native push notifications on your phone when commands complete, even when the app is in the background. Uses Web Push API with VAPID authentication\n- **In-app updates** — auto-update from the UI for npm/yarn/pnpm global installs, with copy-command fallback for other methods\n- **Completion notifications** — browser alerts when background commands finish\n- **30 color themes** with adjustable font size\n- **Port preview** — reverse-proxy a local web server through TermBeam\n- **Image paste** from clipboard\n\n### Secure by Default\n\n- **Auto-generated password** with rate limiting and httpOnly cookies\n- **QR code auto-login** with single-use share tokens (5-min expiry)\n- **DevTunnel integration** for secure remote access — ephemeral or persisted URLs\n- **Security headers** (X-Frame-Options, CSP, nosniff) on all responses; only detected shells allowed\n\n## How It Works\n\nTermBeam starts a lightweight web server that spawns a PTY (pseudo-terminal) with your shell, serves a mobile-optimized [xterm.js](https://xtermjs.org/) UI via Express, and bridges the two over WebSocket. Multiple clients can view the same session simultaneously, and sessions persist when all clients disconnect.\n\n```mermaid\nflowchart LR\n  A[\"Phone / Browser\"] \u003c--\u003e|WebSocket| B[\"TermBeam Server\"]\n  B \u003c--\u003e|PTY| C[\"Shell (zsh/bash)\"]\n  B --\u003e|Express| D[\"Web UI (xterm.js)\"]\n  B -.-\u003e|Optional| E[\"DevTunnel\"]\n```\n\n## CLI Highlights\n\n| Flag                  | Description                                     | Default        |\n| --------------------- | ----------------------------------------------- | -------------- |\n| `--password \u003cpw\u003e`     | Set access password                             | Auto-generated |\n| `--no-password`       | Disable password protection                     | —              |\n| `--tunnel`            | Create an ephemeral devtunnel URL               | On             |\n| `--no-tunnel`         | Disable tunnel (LAN-only)                       | —              |\n| `--persisted-tunnel`  | Reusable devtunnel URL (stable across restarts) | Off            |\n| `--port \u003cport\u003e`       | Server port                                     | `3456`         |\n| `--host \u003caddr\u003e`       | Bind address                                    | `127.0.0.1`    |\n| `--lan`               | Bind to all interfaces (LAN access)             | Off            |\n| `--public`            | Allow public tunnel access (no Microsoft login) | Off            |\n| `-i, --interactive`   | Interactive setup wizard                        | Off            |\n| `--log-level \u003clevel\u003e` | Log verbosity (error/warn/info/debug)           | `info`         |\n\nFor all flags, subcommands, and environment variables, see the [Configuration docs](https://dorlugasigal.github.io/TermBeam/configuration/).\n\n## Background Service\n\nRun TermBeam as an always-on background service using the built-in PM2 integration:\n\n```bash\ntermbeam service install     # interactive wizard — configures PM2, password, tunnel, boot auto-start\ntermbeam service status      # check process info, uptime, memory\ntermbeam service logs        # tail live logs\ntermbeam service restart     # restart after config changes\ntermbeam service uninstall   # stop and remove the service\n```\n\nThe installer checks for [PM2](https://pm2.keymetrics.io/) (and offers to install it), then walks you through password, port, access mode, and boot auto-start options. Config is saved to `~/.termbeam/ecosystem.config.js`.\n\nFor systemd, launchd, and Windows Task Scheduler setup, see the [Running in Background docs](https://dorlugasigal.github.io/TermBeam/running-in-background/).\n\n\u003e 💡 **Keep the host awake** so the service stays reachable while you're away. macOS: pair with [Amphetamine](https://apps.apple.com/app/amphetamine/id937984704) (process trigger on `node`) or wrap with `caffeinate -dims`. Windows: enable [PowerToys Awake](https://learn.microsoft.com/windows/powertoys/) and disable network adapter power saving. Linux: use `systemd-inhibit` in your unit file. See [Keeping the Host Awake](https://dorlugasigal.github.io/TermBeam/running-in-background/#keeping-the-host-awake-) for the full setup.\n\n## Security\n\nTermBeam auto-generates a password and creates a secure tunnel by default, binding to `127.0.0.1` (localhost only). Auth uses httpOnly cookies with 24-hour expiry, login is rate-limited to 5 attempts per minute, QR codes contain single-use share tokens (5-min expiry), and security headers (X-Frame-Options, CSP, nosniff) are set on all responses.\n\nFor the full threat model and safety checklist, see [SECURITY.md](SECURITY.md). For detailed security documentation, see the [Security Guide](https://dorlugasigal.github.io/TermBeam/security/).\n\n## Contributing\n\nContributions welcome — see [CONTRIBUTING.md](CONTRIBUTING.md).\n\n## Changelog\n\nSee [CHANGELOG.md](CHANGELOG.md) for version history.\n\n## License\n\n[MIT](LICENSE)\n\n## Acknowledgments\n\nSpecial thanks to [@tamirdresher](https://github.com/tamirdresher) for the [blog post](https://www.tamirdresher.com/blog/2026/02/26/squad-remote-control) that inspired the solution idea for this project, and for his [cli-tunnel](https://github.com/tamirdresher/cli-tunnel) implementation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdorlugasigal%2Ftermbeam","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdorlugasigal%2Ftermbeam","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdorlugasigal%2Ftermbeam/lists"}