Skip to content

Commit 4e335e8

Browse files
committed
docs: added troubleshooting section to quickstart section
1 parent a3a4ebb commit 4e335e8

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
@@ -60,6 +60,10 @@ First:
6060
- Either plug your Android device and enable USB-debugging via the Developer Options
6161
- Or launch an Android emulator
6262

63+
> [!IMPORTANT]
64+
> 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.`
65+
> It's up to you whether you accept (i.e enter 'Y') or not (i.e. enter 'n').
66+
6367
Then run in your terminal:
6468
6569
1. For Linux/macOS:
@@ -79,14 +83,36 @@ powershell.exe -ExecutionPolicy Bypass -File mobile-use.ps1 `
7983
--output-description "A JSON list of objects, each with 'sender' and 'subject' keys"
8084
```
8185
82-
> [!IMPORTANT]
83-
> At some point, Maestro will ask you `Maestro CLI would like to collect anonymous usage data to improve the product.`
84-
> It's up to you whether you accept (i.e enter 'Y') or not (i.e. enter 'n').
85-
8686
> [!NOTE]
8787
> If using your own device, make sure to accept the ADB-related connection requests that will pop up on your device.
8888
> Similarly, Maestro will need to install its APK on your device, which will also require you to accept the installation request.
8989
90+
#### 🧰 Troubleshooting
91+
92+
The script will try to connect to your device via IP.
93+
Therefore, your device **must be connected to the same Wi-Fi network as your computer**.
94+
95+
##### 1. No device IP found
96+
97+
If the script fails with the following message:
98+
99+
```sh
100+
Could not get device IP. Is a device connected via USB and on the same Wi-Fi network?
101+
```
102+
103+
Then it couldn't find one of the common Wi-Fi interfaces on your device.
104+
Therefore, you must determine what WLAN interface your phone is using via `adb shell ip addr show up`.
105+
Then add the `--interface <YOUR_INTERFACE_NAME>` option to the script.
106+
107+
##### 2. Failed to connect to <DEVICE_IP>:5555 inside Docker
108+
109+
This is most probably an issue with your firewall blocking the connection. Therefore there is no clear fix for this.
110+
111+
##### 3. Failed to pull GHCR docker images (unauthorized)
112+
113+
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.
114+
Try running `docker logout ghcr.io` and then run the script again.
115+
90116
### Manual Launch (Development Mode)
91117

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

0 commit comments

Comments
 (0)