Skip to content

Instantly share code, notes, and snippets.

@agrcrobles
Forked from patrickhammond/android_instructions.md
Last active October 22, 2023 12:09
Show Gist options
  • Save agrcrobles/165ac477a9ee51198f4a870c723cd441 to your computer and use it in GitHub Desktop.
Save agrcrobles/165ac477a9ee51198f4a870c723cd441 to your computer and use it in GitHub Desktop.
Setup Android SDK on OSX with and without the android studio

Hi, I am a fork from https://gist.github.com/patrickhammond/4ddbe49a67e5eb1b9c03.

A high level overview for what I need to do to get most of an Android environment setup and maintained on OSX higher Catalina and Big Sur with and without Android Studio been installed.

Considering the SDK is installed under /Users/<your_user>/Library/Android/sdk folder which is the Android Studio preferred SDK location, but it works fine under /usr/local/share/android-sdk as well, which is a location pretty much used on CI mostly.

Prerequisites:

https://github.com/shyiko/jabba instead ?

See for brew, python3 and NodeJS on nvm see gist https://gist.github.com/agrcrobles/3d945b165871c355b6f169c317958e3e

Java 14

Open JDK 14 works fine with gradle 6.x

Preferred: To install the JDKs 8 ( LTS ) AdoptOpenJDK:

# brew tap adoptopenjdk/openjdk via cask

brew install adoptopenjdk/openjdk/adoptopenjdk8

Alternative: Do not follow this step if followed the step before

brew install java8

SDK Manager

Be sure JAVA_HOME is exported on your bash profile or zshrc depending the shell in usage.

export JAVA_HOME=/Library/Java/JavaVirtualMachines/adoptopenjdk-8.jdk/Contents/Home

See https://developer.android.com/studio/intro/update#sdk-manager

Without Android Studio

From https://stackoverflow.com/questions/64312200/android-sdk-has-been-officially-discontinued-upstream

If you don't want the full android-studio development app (Intellij IDE, etc) and just want the new command line tools...

Per the discontinuation notice...

This SDK Tools package is deprecated and no longer receiving updates. Instead, please use the new command-line tools package.

A quick search reveals that in homebrew land, this new "command-line tools" package is called android-commandlinetools.

$ brew install android-commandlinetools

==> Installing Cask android-commandlinetools
==> Moving Generic Artifact 'cmdline-tools' to '/usr/local/share/android-command
==> Linking Binary 'avdmanager' to '/usr/local/bin/avdmanager'
==> Linking Binary 'lint' to '/usr/local/bin/lint'
==> Linking Binary 'retrace' to '/usr/local/bin/retrace'
==> Linking Binary 'screenshot2' to '/usr/local/bin/screenshot2'
==> Linking Binary 'sdkmanager' to '/usr/local/bin/sdkmanager'
==> Linking Binary 'apkanalyzer' to '/usr/local/bin/apkanalyzer'
🍺  android-commandlinetools was successfully installed!

Or try Command line tools | Android

Use Command line tools or SDK Manager

Quick reminder: Have as many build tools as you want, have a single one platform tool with backwards compatibility :=)

Download and Install Command line tools for mac ( not the android studio unless I need it )

https://developer.android.com/studio#cmdline-tools

https://developer.android.com/studio/command-line

https://developer.android.com/studio/command-line/sdkmanager

Use Homebrew to install Android dev tools: Note that Java8 is tricky since licence changed: https://stackoverflow.com/questions/24342886/how-to-install-java-8-on-mac

brew install gradle
brew remove android-sdk
==> Installing dependencies for gradle: openjdk
==> Installing gradle dependency: openjdk
==> Pouring openjdk--18.0.1.monterey.bottle.tar.gz
🍺  /usr/local/Cellar/openjdk/18.0.1: 641 files, 307.7MB
==> Installing gradle
==> Pouring gradle--7.4.2.all.bottle.tar.gz
🍺  /usr/local/Cellar/gradle/7.4.2: 11,257 files, 267.8MB
==> Running `brew cleanup gradle`...

Optional

brew install ant
brew install maven
brew cask install android-ndk

https://developer.android.com/studio#cmdline-tools

Install all of the Android SDK components (you will be prompted to agree to license info and then this will take a while to run):

If you need to have openjdk first in your PATH run: echo 'export PATH="/usr/local/opt/openjdk/bin:$PATH"' >> ~/.zshrc

For compilers to find openjdk you may need to set: export CPPFLAGS="-I/usr/local/opt/openjdk/include"

QEMU

Be sure Intel Hardware Accelerated Execution Manager (HAXM) is properly installed.

HAXM is a cross-platform hardware-assisted virtualization engine (hypervisor), be sure HAXM is properly installed.

See https://developer.android.com/studio/run/emulator-acceleration

Create and run virtual devices? Nga copied from https://gist.github.com/gasolin/9300f5f9276b2df884c80da3e2c54ffc

avdmanager

avdmanager list (find device skin id, lets use pixel 17)

List the device definitions available:

avdmanager list
...
---------
id: 11 or "Nexus 6P"
    Name: Nexus 6P
    OEM : Google
---------
...

create a virtual device based on device definition "Nexus 6P"

~avdmanager create avd --force --name Nexus6P --abi google_apis/x86_64 --package 'system-images;android-23;google_apis;x86_64' --device "Nexus 6P"


avdmanager create avd -f -n test -d 17 -k 'system-images;android-29;google_apis_playstore;x86_64'
avdmanager list avd (or emulator -list-avds)

/usr/local/share/android-sdk/emulator/emulator -avd test

Error: Package path is not valid. Valid system image paths are:ository... null

SDK preferred location

sdk can be installed on /Library/Android/sdk or /usr/local/ to be sure check it by

macbookpro@Macbooks-MacBook-Pro ~ %   which sdkmanager
/usr/local/bin/sdkmanager

macbookpro@Macbooks-MacBook-Pro ~ % sdkmanager --list

Install build tools and platform tools

The packages argument is an SDK-style path as shown with the --list command, wrapped in quotes (for example, "build-tools;30.0.2" or "platforms;android-28"). You can pass multiple package paths, separated with a space, but they must each be wrapped in their own set of quotes.

For example, here's how to install the latest platform tools (which includes adb and fastboot) and the SDK tools for API level 28:

sdkmanager "platform-tools" "platforms;android-28"

Read terms and conditions

January 16, 2019
---------------------------------------
Accept? (y/N):

Export ANDROID_HOME

export ANDROID_HOME=$HOME/Library/Android/sdk

or

export ANDROID_HOME="/usr/local/share/android-sdk"

or

export ANDROID_HOME="$HOME/Library/Android/sdk"

or

export ANDROID_HOME="/usr/local/bin/sdkmanager"

All locations are valid ones from what I am aware of :)

Suggested: You will have to add the ANDROID_HOME to the profile configuration settings either on .zshrc, .bashrc or .bash_profile

If emulator doesn't run, i am here to remind you to provide access into System Preferences - Security & Privacy

echo export "PATH=/Users/macbookpro/Library/Android/sdk/platform-tools:$PATH" >> ~/.zshenv

Android NDK

TODO

Thanks!!!!

https://gist.github.com/HugoMatilla/f92682b06068b06a6f2a

https://stackoverflow.com/a/44172716/6716408

More helpfull Resources

https://glacion.com/2019/04/06/AVD.html

Happy code!!

License

Opinions are my own

android-28

touch ~/.android/repositories.cfg
yes | sdkmanager --licenses
sdkmanager "platform-tools" "platforms;android-28"
sdkmanager --no_https --install 'build-tools;28'
sdkmanager --no_https --install emulator
sdkmanager --list

android-29

touch ~/.android/repositories.cfg
yes | sdkmanager --licenses
sdkmanager --update
sdkmanager --no_https --install emulator
sdkmanager --no_https --install platform-tools
sdkmanager --no_https --install 'system-images;android-29;google_apis_playstore;x86_64'
sdkmanager --no_https --install 'extras;intel;Hardware_Accelerated_Execution_Manager'
sdkmanager --no_https --install 'build-tools;29.0.2'
sdkmanager --no_https --install 'platforms;android-29'
sdkmanager --list

android-23

touch ~/.android/repositories.cfg
sdkmanager "platform-tools" "platforms;android-23"
sdkmanager "build-tools;23.0.1"

Install HAXM for blazing fast emulators. Check out the "Configuring VM Acceleration on Mac" section here: http://developer.android.com/tools/devices/emulator.html

brew cask install intel-haxm // this might not work on high sierra.

Edit: You can download the dmg and install manually from Intel's site

Install emulators? Nga copied from https://gist.github.com/gasolin/9300f5f9276b2df884c80da3e2c54ffc

sdkmanager --no_https --install emulator
sdkmanager --no_https --install platform-tools
sdkmanager --no_https --install 'system-images;android-29;google_apis_playstore;x86_64'
sdkmanager --no_https --install 'extras;intel;Hardware_Accelerated_Execution_Manager'
sdkmanager --update
sdkmanager --list

Update your environment variables:

https://stackoverflow.com/questions/65711364/how-to-open-the-avd-manager-on-osx-from-iterm2/65711365#65711365

android-28 / android-30

To Copy paste, It's a good idea double check your paths anyways.

export PATH=$PATH:$ANDROID_HOME/emulator
export PATH=$PATH:$ANDROID_HOME/tools
export PATH=$PATH:$ANDROID_HOME/tools/bin
export PATH=$PATH:$ANDROID_HOME/platform-tools

android-23

export PATH=$ANT_HOME/bin:$PATH
export PATH=$MAVEN_HOME/bin:$PATH
export PATH=$GRADLE_HOME/bin:$PATH
export PATH=$ANDROID_HOME/tools:$PATH
export PATH=$ANDROID_HOME/platform-tools:$PATH

Optional: Build tool version specific export

PATH for build-tools/23.0.1

export PATH=$ANDROID_HOME/build-tools/23.0.1:$PATH

PATH for build-tools/28.0.3

export PATH=$ANDROID_HOME/build-tools/28.0.3:$PATH
@agrcrobles
Copy link
Author

agrcrobles commented Nov 28, 2017


➜  MyApp git:(master) ✗ gradle --version

------------------------------------------------------------
Gradle 6.5
------------------------------------------------------------

Build time:   2020-06-02 20:46:21 UTC
Revision:     a27f41e4ae5e8a41ab9b19f8dd6d86d7b384dad4

Kotlin:       1.3.72
Groovy:       2.5.11
Ant:          Apache Ant(TM) version 1.10.7 compiled on September 1 2019
JVM:          13.0.2 (Oracle Corporation 13.0.2+8)
OS:           Mac OS X 10.15.5 x86_64

➜  MyApp git:(master) ✗ adb devices
List of devices attached
R58M92DCXFR	device

Output For android-28

$ sdkmanager --list

  Path                                                  | Version | Description                                | Location
  -------                                               | ------- | -------                                    | -------
  emulator                                              | 30.0.12 | Android Emulator                           | emulator/
  patcher;v4                                            | 1       | SDK Patch Applier v4                       | patcher/v4/
  platforms;android-28                                  | 6       | Android SDK Platform 28                    | platforms/android-28/
  system-images;android-28;google_apis_playstore;x86_64 | 8       | Google Play Intel x86 Atom_64 System Image | system-images/android-28/google_apis_playstore/x86_64/
  tools                                                 | 26.1.1  | Android SDK Tools 26.1.1                   | tools/


Output For android-26

$ sdkmanager --list

  Path               | Version | Description                    | Location           
  -------            | ------- | -------                        | -------            
  build-tools;26.0.2 | 26.0.2  | Android SDK Build-Tools 26.0.2 | build-tools/26.0.2/
  emulator           | 26.1.4  | Android Emulator               | emulator/          
  patcher;v4         | 1       | SDK Patch Applier v4           | patcher/v4/        
  platform-tools     | 26.0.2  | Android SDK Platform-Tools     | platform-tools/    
  tools              | 26.1.1  | Android SDK Tools              | tools/             


@tonejac
Copy link

tonejac commented Dec 20, 2017

Is that correct with the line:
sdkmanager --install "build-tools;23.0.1"

Couldn't get that one to work. Says "Warning: Unknown argument --install".

@tonejac
Copy link

tonejac commented Dec 21, 2017

I took out the --install flag and it worked great.

Thanks for putting this together. Solid info!!

@schutzsmith
Copy link

Same here, removing the --install flag worked like a charm.

Thanks for the updated instructions!

@agrcrobles
Copy link
Author

agrcrobles commented Dec 27, 2017

yea updated, thanks for the feedback!!

@bramus
Copy link

bramus commented Jan 5, 2018

When starting fresh off, you'll also need to install Java. Note that version 9 won't work, so you'll have to specifically target version 8:

brew cask install caskroom/versions/java8

@AceLondon
Copy link

AceLondon commented Jan 8, 2018

Just putting it out there but HAXM install does not support the newest version of macOS - I'm currently on 10.13.2:

==> Standard Output of failed command: HAXM silent installation only supports macOS from 10.8 to 10.12 !

Thanks for the instructions! Beautifully curated!

@nitin7dc
Copy link

thanks 👍

@vsviridov
Copy link

Java9 Workaround (put in the .profile or similar)

export SDKMANAGER_OPTS="-XX:+IgnoreUnrecognizedVMOptions --add-modules java.se.ee"

@stevestock
Copy link

stevestock commented Feb 3, 2018

brew cask install android-sdkautomatically installs java 8
see the android-sdk cask

EDIT: never mind, i misunderstood, brew cask only states the dependency, doesn't automatically install it

@mbunge
Copy link

mbunge commented Feb 13, 2018

I ended up uninstalling JDK9 and installing Java SE Development Kit 8u144. Hope this helps. I also need to android-ndk and android-sdk and follow these stepps

brew cask uninstall android-ndk # Only of installed and ran in to error!
brew cask uninstall android-sdk # Only of installed and ran in to error!
brew cask uninstall java # uninstall java9
brew tap caskroom/versions
brew cask install java8
touch ~/.android/repositories.cfg # without this file, error will occur on next step
brew cask install android-sdk

@Cassidamius
Copy link

Cassidamius commented Feb 22, 2018

Thanks for the instructions! As @AceLondon mentioned above, there's a problem on High Sierra (macOS version 10.13.x).
brew cask install intel-haxm doesn't work
==> Verifying checksum for Cask intel-haxm ==> Installing Cask intel-haxm ==> Running installer script 'silent_install.sh' **==> HAXM silent installation only supports macOS from 10.8 to 10.12 !** ==> Purging files for version 6.2.1,a0:49 of Cask intel-haxm Error: Command failed to execute!

You can download the dmg and install manually from Intel's site:
https://software.intel.com/en-us/android/articles/installation-instructions-for-intel-hardware-accelerated-execution-manager-mac-os-x

@emanueleDiVizio
Copy link

emanueleDiVizio commented Jul 9, 2018

Quick update, ruby command to install homebrew doesn't seem to be working. Here's the command from homebrew website.

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

@jasonnmark
Copy link

Typo:
ruby -e "$(curl -fsSL https://raw.github.com/Homebrew/homebrew/go/install)" should be ") not )"

@andrewhavens
Copy link

2019 Update:

Some packages have been removed or changed (such as java, android-ndk, etc). This is what worked for me:

brew cask install adoptopenjdk8
brew cask install android-sdk

echo "export ANDROID_HOME=/usr/local/share/android-sdk" >> ~/.bash_profile
source ~/.bash_profile

touch ~/.android/repositories.cfg
sdkmanager --update
sdkmanager "platform-tools" "platforms;android-28"

The sdkmanager had a problem when ~/.android/repositories.cfg didn't exist, but by simply creating the file, it solved the problem.

@hroland
Copy link

hroland commented Jul 16, 2019

echo "export ANT_HOME=/usr/local/opt/ant" >> ~/.bash_profile
echo "export MAVEN_HOME=/usr/local/opt/maven" >> ~/.bash_profile
echo "export GRADLE_HOME=/usr/local/opt/gradle" >> ~/.bash_profile
echo "export ANDROID_HOME=/usr/local/share/android-sdk" >> ~/.bash_profile
echo "export ANDROID_NDK_HOME=/usr/local/share/android-ndk" >> ~/.bash_profile
echo "export INTEL_HAXM_HOME=/usr/local/Caskroom/intel-haxm" >> ~/.bash_profile

@gasolin
Copy link

gasolin commented Jul 18, 2019

need install jdk8 via

brew cask install adoptopenjdk/openjdk/adoptopenjdk8

instead of

brew cask install adoptopenjdk8

Here's a 2019 updated version https://gist.github.com/gasolin/9300f5f9276b2df884c80da3e2c54ffc

@cemo
Copy link

cemo commented Oct 21, 2019

@sairajasrikolluru
Copy link

bin/sdkmanager from commandline throws below error -

Exception in thread "main" java.lang.NoClassDefFoundError: javax/xml/bind/annotation/XmlSchema
at com.android.repository.api.SchemaModule$SchemaModuleVersion.(SchemaModule.java:156)

@d-koppenhagen
Copy link

This can ba a problem when using a newer JAVA Version. You can fix this by:

export JAVA_HOME=/Library/Java/JavaVirtualMachines/adoptopenjdk-8.jdk/Contents/Home

@tdrkDev
Copy link

tdrkDev commented Jun 21, 2020

brew tap caskroom/cask is not needed now
First brew cask command is downloading cask repository

@eddsaura
Copy link

I did so many things already that I don't know where am I.

When I try to run cordova run android --device I get the No installed build tools found. Install blablabla...

How is the final version and how can i clean all this mess? 😆

Thanks!

@wanxe
Copy link

wanxe commented Mar 3, 2022

I would invite you a beer without hesitation, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment