![\"TermPilot](\"packages/client/public/icons/favicon.svg\"){kind=icon}
\n\n \n
\n Control your laptop's terminal from your phone.
\n Voice commands, multi-session tabs, real-time mirroring, remote access from anywhere.\n
\n ![\"version\"](\"https://img.shields.io/badge/version-1.0.0-blue?style=flat-square\"){kind=icon}
![\"node\"](\"https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen?style=flat-square&logo=node.js\"){kind=icon}
![\"tests\"](\"https://img.shields.io/badge/tests-103%20passing-brightgreen?style=flat-square\"){kind=icon}
![\"vulnerabilities\"](\"https://img.shields.io/badge/vulnerabilities-0-brightgreen?style=flat-square\"){kind=icon}
![\"security\"](\"https://img.shields.io/badge/security%20audits-3%20passed-brightgreen?style=flat-square\"){kind=icon}
![\"lines](\"https://img.shields.io/badge/LOC-3.8K-blue?style=flat-square\"){kind=icon}
![\"license\"](\"https://img.shields.io/badge/license-MIT-blue?style=flat-square\"){kind=icon}
![\"platform\"](\"https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey?style=flat-square\"){kind=icon}
![\"cost\"](\"https://img.shields.io/badge/cost-%240-brightgreen?style=flat-square\"){kind=icon}
\n Quick Start •\n Features •\n How It Works •\n Architecture •\n Security •\n Quick Start •\n Why TermPilot? •\n Contributing\n
\n\n\n\n---\n\n## Why TermPilot?\n\n**Your terminal shouldn't be tied to your desk.**\n\nYou're running a deployment, a long build, or a database migration. You step away — to grab coffee, to a meeting, to another room. Now you're stuck wondering: *Did it finish? Did it fail? Do I need to type `y` to confirm something?*\n\nOr you're on the couch and need to quickly SSH somewhere, restart a service, check logs. Your laptop is across the room. You have your phone in your hand.\n\n**TermPilot solves this.** One command, and your laptop's terminal is on your phone:\n\n- **Speak instead of type** — Say \"git status\" or \"docker ps\" instead of wrestling with a phone keyboard\n- **Full interactive terminal** — Not just output monitoring. Run vim, htop, interactive prompts — everything works\n- **Mirror what's already running** — Attach to existing tmux sessions and see exactly what's on your laptop screen, in real-time\n- **Access from anywhere** — One flag (`--tunnel`) gives you a public HTTPS URL. Works from cellular, coffee shop WiFi, anywhere\n- **No infrastructure needed** — No servers to deploy, no accounts to create, no subscriptions. It runs on your laptop and your phone's browser. That's it.\n- **Install in 5 seconds** — `npx @abhishekreddy31/term-pilot`. No build steps, no config files, no Docker.\n\nTermPilot is built for developers who want their terminal available wherever they are — without complexity, without cost, and without compromise on functionality.\n\n---\n\n## Quick Start\n\n```bash\n# Install and run (one command)\nnpx @abhishekreddy31/term-pilot\n\n# Or install globally\nnpm install -g @abhishekreddy31/term-pilot\nterm-pilot\n\n# With remote access from anywhere\nterm-pilot --tunnel\n```\n\nCredentials are written to `~/.termpilot/credentials`. Open the URL on your phone.\n\n### From source\n\n```bash\ngit clone https://github.com/Abhishekreddy31/TermPilot.git\ncd TermPilot\npnpm install\npnpm start\n```\n\n---\n\n## Features\n\n### Two Modes\n\n| Mode | What it does |\n|------|-------------|\n| **Independent Sessions** | Create fresh terminal sessions from your phone — like opening new Terminal.app windows |\n| **Mirror Mode** | Attach to existing tmux sessions running on your laptop — bidirectional real-time mirroring |\n\n### Core Capabilities\n\n- **Multi-terminal tabs** — Create, switch, and destroy terminal sessions\n- **Voice commands** — Speak commands, confirm, execute. Understands developer vocabulary (`\"git commit dash m\"` → `git commit -m`)\n- **Extra keys toolbar** — Esc, Tab, Ctrl, Alt, arrow keys, PgUp/PgDn, pipe, tilde — keys your phone keyboard doesn't have\n- **Touch scrolling** — Swipe to scroll through terminal history (5000 lines)\n- **Remote access** — Cloudflare Tunnel gives you a public HTTPS URL for free. Access your terminals from cellular, coffee shop WiFi, anywhere\n- **PWA installable** — Add to home screen for a native app experience. App shell cached for instant loading\n- **Zero cost** — No cloud servers, no paid APIs, no app store fees, no subscriptions\n\n---\n\n## How It Works\n\n```\nPhone (browser/PWA) Your Laptop\n┌──────────────────┐ ┌──────────────────────┐\n│ xterm.js │◄──WebSocket──│ Node.js Server │\n│ Voice Input │──────────────│ ├─ PTY Manager │\n│ Extra Keys │ │ │ └─ /bin/zsh │\n│ Session Tabs │ │ ├─ Tmux Manager │\n│ Login Screen │ │ │ └─ tmux attach │\n└──────────────────┘ │ ├─ Auth (scrypt) │\n │ │ └─ Cloudflare Tunnel│\n │ (optional) └──────────────────────┘\n │\n Cloudflare Edge\n (free, auto TLS)\n```\n\n1. **Server starts** on your laptop, binds to `localhost:3000`\n2. **You log in** from your phone with the credentials from `~/.termpilot/credentials`\n3. **A terminal session** is created — the server spawns a real shell (bash/zsh) via a pseudo-terminal (PTY)\n4. **Everything you type** (keyboard, extra keys, or voice) goes over WebSocket → server writes to PTY\n5. **Shell output** flows back over WebSocket → xterm.js renders it on your phone\n6. **Mirror mode**: attach to existing tmux sessions for bidirectional mirroring — what you see on your laptop, you see on your phone\n7. **Tunnel mode**: Cloudflare proxies traffic so you can access from any network\n\n---\n\n## Architecture\n\n```mermaid\ngraph TB\n subgraph Phone[\"Phone (Any Browser)\"]\n PWA[\"PWA Client\n If TermPilot is useful to you, consider giving it a star.
\n It helps others discover the project.\n
\n \n ![\"GitHub](\"https://img.shields.io/github/stars/Abhishekreddy31/TermPilot?style=for-the-badge&logo=github&label=Star%20on%20GitHub&color=yellow\")