|
| 1 | + |
| 2 | + |
| 3 | +--- |
| 4 | + |
| 5 | +### 📄 `README.md` |
| 6 | + |
| 7 | +```markdown |
| 8 | +# 🧭 iOS Safari Remote Debugger GUI |
| 9 | + |
| 10 | +A simple graphical interface built with Python and Tkinter to help developers debug Safari on iOS devices using Apple's WebKit Remote Debugging Protocol. |
| 11 | + |
| 12 | +This tool allows you to: |
| 13 | +- Start and stop the local WebKit remote debugging server |
| 14 | +- View a list of inspectable pages on connected iOS Safari instances |
| 15 | +- Open the Safari DevTools for a selected page directly in your browser |
| 16 | + |
| 17 | +--- |
| 18 | + |
| 19 | +## 📦 Features |
| 20 | + |
| 21 | +- ✅ Save and remember WebKit folder path |
| 22 | +- ✅ Start/stop WebKit remote debugging server with a click |
| 23 | +- ✅ List all currently available inspectable Safari tabs |
| 24 | +- ✅ Open Safari's DevTools UI for selected pages |
| 25 | +- ✅ Console log output built-in |
| 26 | +- ✅ Cross-platform support (Windows, macOS, Linux) |
| 27 | + |
| 28 | +--- |
| 29 | + |
| 30 | +## 🚀 Getting Started |
| 31 | + |
| 32 | +### 🔧 Requirements |
| 33 | + |
| 34 | +- Python 3.7+ |
| 35 | +- Pip packages: `requests`, `beautifulsoup4` |
| 36 | + |
| 37 | +> You can install the requirements using: |
| 38 | +```bash |
| 39 | +pip install requests beautifulsoup4 |
| 40 | +``` |
| 41 | + |
| 42 | +--- |
| 43 | + |
| 44 | +## 🛠️ Setup |
| 45 | + |
| 46 | +1. Clone this repository: |
| 47 | +```bash |
| 48 | +git clone https://github.com/yourusername/ios-safari-debugger-gui.git |
| 49 | +cd ios-safari-debugger-gui |
| 50 | +``` |
| 51 | + |
| 52 | +2. Run the GUI: |
| 53 | +```bash |
| 54 | +python main.py |
| 55 | +``` |
| 56 | + |
| 57 | +3. Select your local **WebKit folder** (containing `start.sh` or `start.ps1`) via the "Browse" button. |
| 58 | + |
| 59 | +> ⚠️ Make sure your iOS device is connected and Safari is open with Web Inspector enabled. |
| 60 | +
|
| 61 | +--- |
| 62 | + |
| 63 | +## 🧪 Usage |
| 64 | + |
| 65 | +- Click `Start Debugging Server` to launch the local server. |
| 66 | +- Click `Refresh Pages` to load currently opened tabs on your iOS device. |
| 67 | +- Select any page from the list and click `Open Debugger` to open Safari DevTools in your browser. |
| 68 | +- Double-clicking a page also opens it directly. |
| 69 | + |
| 70 | +--- |
| 71 | + |
| 72 | +## 📁 Folder Structure |
| 73 | + |
| 74 | +``` |
| 75 | +. |
| 76 | +├── main.py # The main application file |
| 77 | +├── README.md # This file |
| 78 | +└── .ios_safari_debugger.ini # Auto-generated config file (saves WebKit path) |
| 79 | +``` |
| 80 | + |
| 81 | +--- |
| 82 | + |
| 83 | +## 📸 Screenshots |
| 84 | + |
| 85 | +> *(You can include screenshots here by uploading images to the repo and referencing them like below)* |
| 86 | +
|
| 87 | +``` |
| 88 | + |
| 89 | +``` |
| 90 | + |
| 91 | +--- |
| 92 | + |
| 93 | +## 💡 Notes |
| 94 | + |
| 95 | +- This tool does **not** include WebKit itself. You need to [build WebKit from source](https://webkit.org) or use a precompiled version with `start.sh` or `start.ps1`. |
| 96 | +- Make sure port `9221` is available and not blocked by firewalls. |
| 97 | + |
| 98 | +--- |
| 99 | + |
| 100 | +## 📜 License |
| 101 | + |
| 102 | +This project is licensed under the MIT License. See the `LICENSE` file for more info. |
| 103 | + |
| 104 | +--- |
| 105 | + |
| 106 | +## 🙏 Credits |
| 107 | + |
| 108 | +Built by [longkidkoolstar](https://github.com/longkidkoolstar). Inspired by Apple's WebKit DevTools and the desire for a simple UI to debug iOS Safari. |
| 109 | + |
| 110 | +``` |
| 111 | +
|
| 112 | +--- |
| 113 | +
|
0 commit comments