{"id":50741460,"url":"https://github.com/mango766/portpilot","last_synced_at":"2026-06-10T17:04:18.710Z","repository":{"id":363513662,"uuid":"1263678581","full_name":"mango766/portpilot","owner":"mango766","description":"⚓ A beautiful local services dashboard — discover and access every port running on your machine from a single elegant page.","archived":false,"fork":false,"pushed_at":"2026-06-09T07:14:18.000Z","size":23,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-09T09:13:57.813Z","etag":null,"topics":["alpinejs","dashboard","developer-tools","fastapi","localhost","macos","port-scanner","psutil","python","tailwindcss"],"latest_commit_sha":null,"homepage":"https://github.com/mango766/portpilot","language":"Python","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/mango766.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-06-09T07:04:58.000Z","updated_at":"2026-06-09T07:14:21.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/mango766/portpilot","commit_stats":null,"previous_names":["mango766/portpilot"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/mango766/portpilot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mango766%2Fportpilot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mango766%2Fportpilot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mango766%2Fportpilot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mango766%2Fportpilot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mango766","download_url":"https://codeload.github.com/mango766/portpilot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mango766%2Fportpilot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34161297,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-10T02:00:07.152Z","response_time":89,"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":["alpinejs","dashboard","developer-tools","fastapi","localhost","macos","port-scanner","psutil","python","tailwindcss"],"created_at":"2026-06-10T17:04:17.915Z","updated_at":"2026-06-10T17:04:18.703Z","avatar_url":"https://github.com/mango766.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# ⚓ PortPilot\n\n**Your local services, all in one harbor.**\n\nA beautiful, zero-config dashboard that discovers every port running on your machine\nand gives you one click to open them — no more `lsof | grep`, no more lost tabs.\n\n[![Python](https://img.shields.io/badge/python-3.10%2B-3776AB?logo=python\u0026logoColor=white)](https://www.python.org/)\n[![FastAPI](https://img.shields.io/badge/FastAPI-0.110%2B-009688?logo=fastapi\u0026logoColor=white)](https://fastapi.tiangolo.com/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\n[![Made with love](https://img.shields.io/badge/made%20with-%E2%9D%A4-ff69b4)](#)\n\n\u003c/div\u003e\n\n---\n\n## ✨ Why PortPilot?\n\nYou spin up a Vite dev server, a Flask API, a Jupyter notebook, a small Streamlit demo,\nmaybe something on `:8080` you forgot about an hour ago…\n\nBy 4 PM you have **no idea what's running where**.\n\nPortPilot solves this in the simplest way possible:\n\n\u003e **One URL: `http://localhost:7777`. All your services, beautifully listed. One click to open any of them.**\n\n## 🌟 Features\n\n- 🔍 **Auto-discovery** — finds every TCP listener on your machine via `psutil`, no config files\n- 🟢 **Smart status** — concurrent HTTP probing tells you what's reachable, what's broken, what's not HTTP\n- 🏷️ **Friendly names** — pulls each service's `\u003ctitle\u003e` so you see \"Sovereign Guardian Dashboard\", not just `:8080`\n- 🎨 **Beautiful UI** — glassmorphism, soft gradients, dark mode, smooth animations — designed to be the kind of tab you *want* to keep open\n- ⚙️ **System / user separation** — system services collapse out of your way by default\n- 🔎 **Instant search** — filter by port, name, process, or path\n- 🪶 **Zero build** — pure HTML/Tailwind/Alpine on the front, FastAPI on the back\n- 🔒 **Local-only** — binds to `127.0.0.1` by default; never exposed to your network\n\n## 🖼️ Preview\n\n```\n╔══════════════════════════════════════════════════════════╗\n║  ⚓ PortPilot                          [🔍 Search] [↻]   ║\n║                                                           ║\n║  ┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐    ║\n║  │ Total 12 │ │ Running 9│ │ My apps 7│ │ System 5 │    ║\n║  └──────────┘ └──────────┘ └──────────┘ └──────────┘    ║\n║                                                           ║\n║  MY SERVICES (7)                                          ║\n║  ┌────────────────┐ ┌────────────────┐ ┌──────────────┐ ║\n║  │ 🟢 :3000  RUN  │ │ 🟢 :5000  RUN  │ │ 🟡 :6379 NON │ ║\n║  │ Vite Dev       │ │ Flask · App    │ │ redis-server │ ║\n║  │ node · pid 1234│ │ python · pid 5 │ │ pid 8765     │ ║\n║  │ ~/code/myapp   │ │ ~/api          │ │ /usr/local   │ ║\n║  └────────────────┘ └────────────────┘ └──────────────┘ ║\n║                                                           ║\n║  ▸ System services (5)                                    ║\n╚══════════════════════════════════════════════════════════╝\n```\n\n## 🚀 Quick Start\n\n### Option 1: One-line script\n\n```bash\n./scripts/start.sh\n```\n\nThen open **\u003chttp://localhost:7777\u003e** in your browser.\n\n### Option 2: Manual\n\n```bash\npip install -r requirements.txt\npython -m portpilot.server\n```\n\n### Option 3: Install as a CLI\n\n```bash\npip install -e .\nportpilot --port 7777\n```\n\n## ⚙️ Configuration\n\nPortPilot is intentionally config-free. The only knobs are CLI flags:\n\n| Flag        | Default     | Description                               |\n| ----------- | ----------- | ----------------------------------------- |\n| `--host`    | `127.0.0.1` | Interface to bind. Keep loopback for safety. |\n| `--port`    | `7777`      | Dashboard port.                           |\n| `--reload`  | _off_       | Dev mode (auto-reload on code changes).   |\n\n\u003e 💡 **Why not port 6666?** It looks tempting (memorable, \"lucky 6\"),\n\u003e but Chromium and Firefox hard-block 6666/6667/6668/6669 because\n\u003e they're IRC's well-known ports. Browsers will silently refuse to\n\u003e connect with `ERR_UNSAFE_PORT`. We picked **7777** for compatibility.\n\u003e Other \"safe \u0026 memorable\" choices: `5555`, `8888`, `9999`.\n\n## 🧱 Architecture\n\n```\n┌──────────────────────────────────────────┐\n│  Browser  http://localhost:7777           │\n└─────────────────┬─────────────────────────┘\n                  │\n          ┌───────▼────────┐\n          │   FastAPI      │\n          │   ├─ /         → static SPA\n          │   └─ /api/...  → JSON\n          └───────┬────────┘\n                  │\n       ┌──────────┼──────────┐\n       ▼                     ▼\n  discovery.py          prober.py\n  (psutil scan)         (httpx async)\n```\n\n- **`discovery.py`** — scans listening TCP ports, attaches PID/cwd/cmdline.\n- **`prober.py`** — async HTTP probe with bounded concurrency, extracts `\u003ctitle\u003e`.\n- **`server.py`** — FastAPI routes + 5 s TTL cache to avoid hammering the OS.\n- **`static/index.html`** — single-file SPA (Tailwind + Alpine.js via CDN).\n\n## 🧪 Development\n\n```bash\n# Install dev deps\npip install -e \".[dev]\"\n\n# Run tests\npytest\n\n# Lint\nruff check src tests\n\n# Run with hot reload\npython -m portpilot.server --reload\n```\n\n## 📁 Project Structure\n\n```\nportpilot/\n├── src/portpilot/\n│   ├── __init__.py\n│   ├── discovery.py      # port scanning\n│   ├── prober.py         # HTTP probing\n│   └── server.py         # FastAPI app + CLI\n├── static/\n│   └── index.html        # the dashboard UI\n├── scripts/\n│   ├── start.sh          # one-line launcher\n│   └── stop.sh\n├── tests/\n├── pyproject.toml\n└── README.md\n```\n\n## 🗺️ Roadmap\n\n- [ ] One-click \"kill\" with confirmation modal\n- [ ] Optional `~/.portpilot.yaml` for friendly aliases\n- [ ] launchd / systemd auto-start templates\n- [ ] Service health history (sparkline)\n- [ ] Export discovered services as JSON / Markdown\n\n## 🤝 Contributing\n\nPRs welcome! Please:\n1. Open an issue describing your idea first.\n2. Keep functions under ~80 lines and lines under 100 chars (`ruff` enforces this).\n3. Add a test if you're adding logic.\n\n## 📜 License\n\n[MIT](LICENSE) © PortPilot Contributors\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmango766%2Fportpilot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmango766%2Fportpilot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmango766%2Fportpilot/lists"}