There are instructions for other platforms linked from the get the code page.
Are you a Google employee? See go/building-chrome instead.
Most development is done on Ubuntu. Other distros may or may not work; see the Linux instructions for some suggestions.
Building the Android client on Windows or Mac is not supported and doesn't work.
git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git
depot_tools to the end of your PATH (you will probably want to put this in your
~/.zshrc). Assuming you cloned
chromium directory for the checkout and change to it (you can call this whatever you like and put it wherever you like, as long as the full path has no spaces):
mkdir ~/chromium && cd ~/chromium fetch --nohooks android
If you don't want the full repo history, you can save a lot of time by adding the
--no-history flag to
Expect the command to take 30 minutes on even a fast connection, and many hours on slower ones.
If you've already installed the build dependencies on the machine (from another checkout, for example), you can omit the
--nohooks flag and
fetch will automatically execute
gclient runhooks at the end.
fetch completes, it will have created a hidden
.gclient file and a directory called
src in the working directory. The remaining instructions assume you have switched to the
If you have an existing Linux checkout, you can add Android support by appending
target_os = ['android'] to your
.gclient file (in the directory above
echo "target_os = [ 'android' ]" >> ../.gclient
gclient sync to pull the new Android dependencies:
(This is the only difference between
fetch android and
Once you have checked out the code, run
to get all of the dependencies you need to build on Linux, plus all of the Android-specific dependencies (you need some of the regular Linux dependencies because an Android build includes a bunch of the Linux tools and utilities).
Once you've run
install-build-deps at least once, you can now run the Chromium-specific hooks, which will download additional binaries and other things you might need:
Optional: You can also install API keys if you want your build to talk to some Google services, but this is not necessary for most development and testing purposes.
Chromium uses Ninja as its main build tool along with a tool called GN to generate
.ninja files. You can create any number of build directories with different configurations. To create a build directory which builds Chrome for Android, run:
gn gen --args='target_os="android"' out/Default
Defaultwith another name, but it should be a subdirectory of
gn helpon the command line or read the quick start guide.
Also be aware that some scripts (e.g.
adb_gdb.py) require you to set
Build Chromium with Ninja using the command:
ninja -C out/Default chrome_public_apk
You can get a list of all of the other build targets from GN by running
gn ls out/Default from the command line. To compile one, pass the GN label to Ninja with no preceding “//” (so, for
ninja -C out/Default chrome/test:unit_tests).
The Google Play Store allows apps to send customized
.apk files depending on the version of Android running on a device. Chrome uses this feature to target 3 different versions using 3 different ninja targets:
Note: These instructions use
chrome_public_apk, but either of the other two targets can be substituted.
Note: These targets are actually the open-source equivalents to the closed-source targets that get shipped to the Play Store.
Make sure your Android device is plugged in via USB, and USB Debugging is enabled.
To enable USB Debugging:
You may also be prompted to allow access to your PC once your device is plugged in.
You can check if the device is connected by running:
Which prints a list of connected devices. If not connected, try unplugging and reattaching your device.
ninja -C out/Default chrome_public_apk
And deploy it to your Android device:
The app will appear on the device as “Chromium”.
Wraps the content module (but not the /chrome embedder). See https://www.chromium.org/developers/content-module for details on the content module and content shell.
ninja -C out/Default content_shell_apk out/Default/bin/content_shell_apk install
this will build and install an Android apk under
If you want to build the complete Android WebView framework component and test the effect of your chromium changes in Android apps using WebView, you should follow the Android AOSP + chromium WebView instructions
For Content shell:
out/Default/bin/content_shell_apk launch [--args='--foo --bar'] http://example.com
For Chrome public:
out/Default/bin/chrome_public_apk launch [--args='--foo --bar'] http://example.com
Logging is often the easiest way to understand code flow. In C++ you can print log statements using the LOG macro. In Java, refer to android_logging.md.
You can see these log via
adb logcat, or:
To debug C++ code, use one of the following commands:
out/Default/bin/content_shell_apk gdb out/Default/bin/chrome_public_apk gdb
See Android Debugging Instructions for more on debugging, including how to debug Java code.
For information on running tests, see Android Test Instructions.
“Incremental install” uses reflection and side-loading to speed up the edit & deploy cycle (normally < 10 seconds). The initial launch of the apk will be a little slower since updated dex files are installed manually.
is_component_build = truein your GN args
_incrementaltargets defined (e.g.
chrome_public_apk_incremental) except for Webview and Monochrome
Here's an example:
ninja -C out/Default chrome_public_apk_incremental out/Default/bin/chrome_public_apk install --incremental --verbose
For gunit tests (note that run_*_incremental automatically add
--fast-local-dev when calling
ninja -C out/Default base_unittests_incremental out/Default/bin/run_base_unittests_incremental
For instrumentation tests:
ninja -C out/Default chrome_public_test_apk_incremental out/Default/bin/run_chrome_public_test_apk_incremental
To avoid typing
_incremental when building targets, you can use the GN arg:
incremental_apk_by_default = true
This will make
chrome_public_apk build in incremental mode.
These instructions are only necessary for Chrome 51 and earlier.
In the case where you want to modify the native code for an existing release of Chrome for Android (v25+) you can do the following steps. Note that in order to get your changes into the official release, you'll need to send your change for a codereview using the regular process for committing code to chromium.