Setup Android Command-line Tools in Windows

Setup Android Cmd-line Tools in Windows

The purpose of this article is to help a system administrator in setting up Android command-line tools on a Windows computer so that anyone can use Android emulator and other command-line tools without having to install complete Android Studio SDK. This will save the disk space on a system if the user need to use cmdline tools only and does not need a full-blown android studio development environment.

Downloading and installing Java JDK

1. Download and install the latest version of Java JDK using following link:

https://www.oracle.com/java/technologies/javase-downloads.html

2. Click on JDK Download

3. On downloads page, scroll down and click on download link next to Windows x64 Installer.

4. This will open a popup with a checkbox and a download button. You need to check the box but do not directly click the download button here since this will take you to a login page. Instead, right click on the button and select Copy link option from context menu.

5. Open a text editor, paste the copied link, and change the download link as shown in following image.

You just need the URL highlighted in red and then modify the text where it says “otn” to “otn-pub” and then paste the modified link (highlighted green) in browser address bar. This will start the download.

6. When the download is completed, install the JDK to default location. Please note that the commercial use of Oracle JDK may require a valid license to be purchased. If you don’t want to purchase a license, you could use OpenJDK as discussed in this article.

Downloading and installing Android command-line tools

1. Open the following link in browser and click on Download Options button:

https://developer.android.com/studio

2. Scroll down to Command line tools only section and click on the download link next to Windows. This will download a zip file.

3. The latest version of cmdline-tools has some issues and it is rarely documented how to fix these issues. So please follow the next steps exactly the same way as mentioned:
4. Open run dialog (press windows logo key + R), type the following path and hit enter:

C:\Users\Surender\AppData\Local\

Make sure you change your username.

5. Now create a new folder named Android and inside that create another folder named cmdline-tools and inside that create another folder named tools. So, in the end you will have:

C:\Users\Surender\AppData\Local\Android\cmdline-tools\tools

6. Now open the zip file downloaded in step 2 with 7-zip. Many users reported the issues when used inbuilt zip utility of windows to extract the downloaded zip file. So, we will use 7-zip (a free tool) to extract the zip file. You can download the 7-zip utility from https://www.7-zip.org/download.html
7. In 7-zip manager, you will see a folder named cmdline-tools.

8. Double click on cmdline-tools folder to go inside. Now you will see 4 items (bin, lib, NOTICE.txt, and source.properties).

Click on the extract button and paste the “C:\Users\Surender\AppData\Local\Android\cmdline-tools\tools” path in Copy to field and click OK. Again, make sure you change your username.

9. Open the directory where you extracted the files. Now rename the folder named “bin” to “latest”. So, in the end you will have directory structure as shown in following image:

C:\Users\Surender\AppData\Local\Android\cmdline-tools\tools\latest

10. You can copy this path as you will need this in next section while setting up environment variables.

Setting up environment variables

1. Open run dialog (press windows logo key + R).
2. Type “sysdm.cpl ,3” without quotes to open advanced system properties.
3. Click on Environment Variables

1. 4. Under User variables section, select Path and click on Edit

5. Now click on New and paste the path that you copied from step 10 from previous section.

C:\Users\Surender\AppData\Local\Android\cmdline-tools\tools\latest

6. 6. Repeat step 5 again to add the environment variable for Java JDK you installed initially. For your reference, on my PC JDK was installed in C:\Program Files\Java\jdk1.8.0_301\bin, So, I will copy this path.

7. Now click on OK twice and you are good to go to next section.

Updating and running SDK manager

If everything you have done so far is correct, you will not run into any issues. To update the SDK manager command-line tool, follow these steps:

1. Open run dialog, type cmd, and hold Ctrl + Shift keys and hit Enter. Press YES on the popup. This will launch an elevated command prompt.
2. Now type “sdkmanager” without quotes and hit enter. If you do not get any error, that’s a success.

Common Problems

Problem 1

You see an error that says “sdkmanager is not recognized as an internal or external command, operable program or batch file.”

Solutions:

You need to revisit the Setting up environment variables section and see if you correctly added the environment variable and copied the correct path for android cmdline-tools. Checkout this video to learn how to setup environment variables in Windows

Problem 2

You see an error that says “Error: Could not find or load main class”.

Solutions:

You need to make sure you extracted the android cmdline-tools in AppData directory inside your user profile. If you extracted it inside the Program Files directory, you might run into this error.

Another thing you need to do is to revisit the Setting up environment variables section and see if you correctly added the environment variables.

Problem 3

You see a warning that says “Warning: Failed to download any source lists!” OR “Warning: IO exception while downloading manifest” OR “Warning: Still waiting for package manifests to be fetched remotely”

Solutions:

You need to see if something is blocking your connection. Most probably it will be your Antivirus software. You could temporarily disable it or at least disable scanning of encrypted connections.

Installing Platform Tools, System images and APIs

Now we can install the platform tools, system images, emulator, google API levels etc directly from command line. To do this, follow these steps:

1. Open run dialog, type cmd, and hold Ctrl + Shift keys and hit Enter. Press YES on the popup. This will launch an elevated command prompt.
2. Type the following command and hit enter:

sdkmanager "platform-tools" "platforms;android-29" "system-images;android-29;google_apis;x86_64"

In above command, “android-29” means Android version 10. If you want to download and try Android 11, you can replace “android-29” with “android-30”. You can install multiple android versions simultaneously but make sure your PC has enough storage space.

3. You will be prompted with a license agreement. Type Y to agree and hit enter to continue.

This command will take a while to complete since it will download a lot of packages from internet. Make sure you are connected to an unmetered connection where data charges do not apply.

4. Once the above command is complete, you will see multiple directories got created inside C:\Users\Surender\AppData\Local\Android

5. Next, we will add an environment variable for emulator directory. Go inside emulator directory, click on address bar of file explorer and copy its path.

6. Repeat the steps 1 through 5 from Setting up environment variables section to add emulator directory to Path.
7. Now we will create our first android virtual device (aka AVD). To create an AVD, type the following command and hit enter:

avdmanager create avd -n AVDv10 -k "system-images;android-29;google_apis;x86_64"

You can specify the name for AVD with -n switch. I chose AVDv10 since it will be an Android 10 device.

8. You can use “avdmanager list avd” command to view the created AVDs.

Launching your android virtual device (AVD)

To launch your first android virtual device, follow these steps:

1. Open run dialog, type cmd, and hold Ctrl + Shift keys and hit Enter. Press YES on the popup. This will launch an elevated command prompt.
2. Type the following command and hit enter:

emulator @AVDv10

This command will start showing some output and you will see your first AVD launching in new window.

If you see an error that says “emulator is not recognized as an internal or external command, operable program or batch file.”, you need to make sure you have correctly added the emulator directory to Path variable (see steps 5 and 6 from Installing Platform Tools, System images and APIs section).

Deleting your android virtual device (AVD)

To delete the AVD you just created, you can use the following command:

avdmanager delete avd -n AVDv10

Using Android Debug Bridge (ADB)

Android Debug Bridge (adb) is a command-line tool that lets you communicate with an android device. The adb command facilitates a variety of device actions, such as installing and debugging apps, transferring data to/from android device, running shell commands on android device etc.

If you are following along this guide since start, you have already installed the adb tool. You only need to add it to environment variable so that you can start it from anywhere in command prompt. To add the environment variable, do the following:

1. Open the following path in file explorer:

C:\Users\Surender\AppData\Local\Android\platform-tools

Make sure you change your user name. If you cannot find the “platform-tools” directory in your PC, run the following command in an elevated cmd prompt:

sdkmanager "platform-tools"

2. Copy “C:\Users\Surender\AppData\Local\Android\platform-tools” directory path from explorer’s address bar.
3. Add the copied path to environment variable. For more information on how to do it, see steps 1 through 5 in Setting up environment variables section.
4. Once the environment variable is set, open a command prompt, type “adb version” and hit enter.
5. If you do not see any error, you are good to go to next step. If you see an error that says “adb is not recognized as an internal or external command, operable program or batch file.”, please check you have correctly followed steps 1 through 3 in this section.
6. To see a list of devices connected, you can use “adb devices” command without quotes.

7. To install an app using apk file, you can use “adb install apk_name” command without quotes.

8. To launch a shell to run commands on connected android device or AVD, you can use “adb shell” command without quotes.

9. To transfer a file to connected android device or AVD, you can use “adb push source destination”.

10. To transfer a file from the connected android device or AVD to your computer, you can use “adb pull source destination”.

11. To shutdown the connected android device or AVD from your computer, you can use “adb shell reboot -p” command (-p stands for -poweroff).

This is just a glimpse of what you can do with adb. There is a lot more to this but you got the idea anyway.

If you like this post, please share this with your family and friends.