@diptothakur/localpeek
v1.0.1
Published
Open your local dev project on your phone over LAN. Zero cloud, zero tunnels, zero setup.
Maintainers
Readme
LocalPeek
See your local dev project on your phone in 5 seconds zero cloud, zero tunnels, zero setup.
One command turns any localhost project into a scannable QR code on your own Wi-Fi.
npx localpeekThat's it. Scan the QR code. Your project opens on your phone.
Why LocalPeek
Testing responsive design usually means deploying, tunneling through ngrok, or typing your laptop's IP address into your phone by hand. LocalPeek skips all of that.
- ⚡ One command, zero config
npx localpeekand you're done, no flags required - 🔒 100% local, always traffic never leaves your Wi-Fi network. No cloud relay, no account, no telemetry, no data collection
- 📷 Real terminal QR code scan and go, no typing IP addresses on a phone keyboard
- 🧠 Auto-detects your stack Plain HTML, Vite, Next.js, Astro, Vue, Nuxt, Svelte, SvelteKit, Angular, Remix
- 🛡️ Never touches your project files read-only detection, your
devscript stays the source of truth - 🖥️ Cross-platform Windows, macOS, Linux, WSL, and phone hotspots all work
- 🪶 Tiny footprint one dependency, no bloated framework underneath
If that saved you a ngrok signup or a "what's my IP" search, a ⭐ on the repo goes a long way it's how other developers find this instead of a heavier alternative.
Install
The whole point is that you usually don't need to install anything:
npx localpeekPrefer it always available as a command:
npm install -g localpeeklocalpeek # full command
lp # short aliasUsage
cd your-project
localpeeklocalpeek # detect and run the current project
localpeek --port 5000 # ask for a specific port
localpeek --iface eth0 # prefer a specific network interface
localpeek --dir ../app # point at a different project folder
localpeek --help # see all optionsWhat happens under the hood
- Reads the current folder and figures out what kind of project it is.
- Starts (or reuses) the dev server, bound so your phone can reach it not just
localhost. - Finds your computer's real LAN IP address (skipping VPNs, Docker, and virtual adapters).
- Renders a QR code directly in your terminal no image file, no upload, no third-party API.
- You scan it. Your phone opens the project. Live-reload, dev tools, everything works as normal.
Nothing here talks to the internet. LocalPeek never sends your project, your code, your IP, or anything else off of your machine.
Supported projects
| Project type | Support |
|---|---|
| Plain HTML/CSS/JS | ✅ built-in static server |
| Vite | ✅ native adapter |
| Next.js | ✅ native adapter |
| Astro | ✅ native adapter |
| Vue, Nuxt, Svelte, SvelteKit, Angular, Remix | ✅ via generic adapter (reuses your dev script) |
| Anything else with a dev script | ✅ generic fallback |
Specs
| | |
|---|---|
| Dependencies | 1 (qrcode-terminal) |
| Requires | Node.js ≥ 16 |
| Platforms | Windows · macOS · Linux · WSL |
| Network | Same-LAN only Wi-Fi, Ethernet, or phone hotspot |
| Cloud/telemetry | None. Ever. |
| Project files | Read-only never modified |
Full setup requirements, firewall notes, and troubleshooting: see GUIDE.md.
Support the project
If LocalPeek saved you time:
- ⭐ Star the repo the easiest way to help others find it
- 🐛 Open an issue if something breaks on your setup
- 👀 Follow @dipto-thakur for more small, focused dev tools like this one
License
MIT see LICENSE.
Built by Dipto Thakur.
