Skip to content

Commit 1f4b8a6

Browse files
committed
docs: added troubleshooting section to quickstart section
1 parent 9865fc1 commit 1f4b8a6

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

README.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,10 @@ First:
6464
- Either plug your Android device and enable USB-debugging via the Developer Options
6565
- Or launch an Android emulator
6666

67+
> [!IMPORTANT]
68+
> At some point, the terminal will HANG, and Maestro will ask you `Maestro CLI would like to collect anonymous usage data to improve the product.`
69+
> It's up to you whether you accept (i.e enter 'Y') or not (i.e. enter 'n').
70+
6771
Then run in your terminal:
6872
6973
1. For Linux/macOS:
@@ -83,14 +87,36 @@ powershell.exe -ExecutionPolicy Bypass -File mobile-use.ps1 `
8387
--output-description "A JSON list of objects, each with 'sender' and 'subject' keys"
8488
```
8589
86-
> [!IMPORTANT]
87-
> At some point, Maestro will ask you `Maestro CLI would like to collect anonymous usage data to improve the product.`
88-
> It's up to you whether you accept (i.e enter 'Y') or not (i.e. enter 'n').
89-
9090
> [!NOTE]
9191
> If using your own device, make sure to accept the ADB-related connection requests that will pop up on your device.
9292
> Similarly, Maestro will need to install its APK on your device, which will also require you to accept the installation request.
9393
94+
#### 🧰 Troubleshooting
95+
96+
The script will try to connect to your device via IP.
97+
Therefore, your device **must be connected to the same Wi-Fi network as your computer**.
98+
99+
##### 1. No device IP found
100+
101+
If the script fails with the following message:
102+
103+
```
104+
Could not get device IP. Is a device connected via USB and on the same Wi-Fi network?
105+
```
106+
107+
Then it couldn't find one of the common Wi-Fi interfaces on your device.
108+
Therefore, you must determine what WLAN interface your phone is using via `adb shell ip addr show up`.
109+
Then add the `--interface <YOUR_INTERFACE_NAME>` option to the script.
110+
111+
##### 2. Failed to connect to <DEVICE_IP>:5555 inside Docker
112+
113+
This is most probably an issue with your firewall blocking the connection. Therefore there is no clear fix for this.
114+
115+
##### 3. Failed to pull GHCR docker images (unauthorized)
116+
117+
Since UV docker images rely on a `ghcr.io` public repositories, you may have an expired token if you used `ghcr.io` before for private repositories.
118+
Try running `docker logout ghcr.io` and then run the script again.
119+
94120
### Manual Launch (Development Mode)
95121

96122
For developers who want to set up the environment manually:

0 commit comments

Comments
 (0)