Skip to content

[Minor] Fixing Windows install doc #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[Minor] Fixing Windows install doc #106

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
411b6c6
Fixing Windows install doc
anjannair Dec 27, 2024
229435b
Few more improvements added
anjannair Dec 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 23 additions & 10 deletions getting-started/installing-maestro/windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@ description: A step by step guide to installing Maestro on Windows

# Windows

Maestro works great on Windows computers, but there are a few unique setup steps to be aware of. This guide will walk you through the end-to-end steps for getting started with Maestro on a Windows machine.
Maestro works great on Windows computers, but there are a few unique setup steps to be aware of. This guide will walk you through the end-to-end steps for getting started with Maestro on a Windows machine.

Alternatively, if you would like a video guide for this installation process you can directly click [here](https://www.youtube.com/watch?v=VLi1Pu2Kb-4).

### Pre-Requisites

1. PowerShell is installed in your Windows system.
2. Install Android Studio on your Windows machine.
2. Install [Android Studio](https://developer.android.com/studio) on your Windows machine.
3. Add ANDROID\_HOME to your Windows environment variable.
1. To check if your ANDROID\_HOME setup is correctly done, open a PowerShell terminal and run this command `adb --version.`
1. To check if your ANDROID\_HOME setup is correctly done, open a PowerShell terminal and run this command `adb --version`.
2. Note down the ADB version.
4. Install Java JDK 11 and set JAVA\_HOME
1. Run `java --version` to check if the Java is installed correctly.
Expand Down Expand Up @@ -58,7 +60,7 @@ sudo apt install openjdk-21-jdk
Installing Maestro is now just a matter of running following one command.

```
curl -Ls "https://get.maestro.mobile.dev" | bash
curl -Ls "https://get.maestro.mobile.dev" | bash
```

**Tada! 🎉**
Expand All @@ -75,18 +77,28 @@ maestro --version

### Let's set you up to use Android in your freshly installed WSL2

* Download the Android command line tools zip file from [Android official site.](https://developer.android.com/studio)
* Use the following instructions to set up Android command lines correctly in your WSL2.
* Download the Android command line tools zip file by using the following command -

Note - **Before running the command, replace the `<>` in the URL with the version number listed under the Command Line Tools section on the [Android Studio](https://developer.android.com/studio) website.**.

```
curl \
--output commandlinetools-linux.zip \
"https://dl.google.com/android/repository/commandlinetools-linux-<>_latest.zip"
```

* Use the following instructions to set up Android command lines correctly in your WSL2.

* Open WSL2 terminal.
* Create a new directory in your home directory.

```
~ $ mkdir Android
~ $ cd Android
$ cd ~
$ mkdir Android
$ cd Android
```

* Unzip the Android command line tools zip file in the `android` directory using this command: `unzip ~<command_line_zip_filename>.zip`
* Unzip the Android command line tools zip file in the `Android` directory using this command: `unzip commandlinetools-linux.zip`
* In the `Android` directory perform following actions.

```
Expand Down Expand Up @@ -129,7 +141,7 @@ maestro --version
```

* This will start the adb server in the Windows host.
* Note down the IPV4 address of your Windows host PC/machine.
* Note down the IPV4 address of your Windows host PC/machine. You can get the IP address of your Windows device by typing `Get-NetIPAddress` on your PowerShell terminal.

**TROUBLESHOOTING:**

Expand Down Expand Up @@ -161,6 +173,7 @@ Yes, at this point, you are free to start your automation.
```
If your Android emulator is not up and running in the Windows host, the Maestro test
command fails to find the installed emulator.

At this point, it is recommended that you fire up your emulator before running the flow
using Maestro.
```