Repository files navigation

This repository holds the build tools needed to build the Brave desktop browser for macOS, Windows, and Linux. In particular, it fetches and syncs code from the projects defined inpackage.json andsrc/brave/DEPS:

• Chromium
  • Fetches code viadepot_tools.
  • Sets the branch for Chromium (ex: 65.0.3325.181).
• brave-core
  • Mounted atsrc/brave.
  • Maintains patches for 3rd party Chromium code.
• adblock-rust
  • Implements Brave's ad-block engine.
  • Linked throughbrave/adblock-rust-ffi.

You canvisit our website to get the latest stable release.

Please see thecontributing guidelines.

OurWiki also has some useful technical information.

Join the Q&A community if you'd like to get more involved with Brave. You canask for help,discuss features you'd like to see, and a lot more. We'd love to have your help so that we can continue improving Brave.

Help us translate Brave to your language by submitting translations athttps://explore.transifex.com/brave/brave_en/.

Follow@brave on X for important news and announcements.

Follow the instructions for your platform:

• macOS
• iOS
• Windows
• Linux
• Android

Once you have the prerequisites installed, you can get the code and initialize the build environment.

git clone git@github.com:brave/brave-core.git path-to-your-project-folder/src/bravecd path-to-your-project-folder/src/bravenpm install# the Chromium source is downloaded, which has a large history (gigabytes of data)# this might take really long to finish depending on internet speednpm run init

brave-core based android builds should usenpm run init -- --target_os=android --target_arch=arm (or whichever CPU type you want to build for)brave-core based iOS builds should usenpm run init -- --target_os=ios

You can also set the target_os and target_arch for init and build using:

npm config set target_os androidnpm config set target_arch arm

Additional parameters needed to build are documented athttps://github.com/brave/brave-browser/wiki/Build-configuration

Internal developers can find more information athttps://github.com/brave/devops/wiki/%60.env%60-config-for-Brave-Developers

The default build type is component.

# start the component build compilenpm run build

To do a release build:

# start the release compilenpm run build Release

brave-core based android builds should usenpm run build -- --target_os=android --target_arch=arm or set the npm config variables as specified above forinit

brave-core based iOS builds should use the Xcode project found inios/brave-ios/App. You can open this project directly or runnpm run ios_bootstrap -- --open_xcodeproj to have it opened in Xcode. See theiOS Developer Environment for more information on iOS builds.

Running a release build withnpm run build Release can be very slow and use a lot of RAM, especially on Linux with the Gold LLVM plugin.

To run a statically linked build (takes longer to build, but starts faster):

npm run build -- Static

To run a debug build (Component build with is_debug=true):

npm run build -- Debug

NOTE: the build will take a while to complete. Depending on your processor and memory, it could potentially take a few hours.

To start the build:

npm start [Release|Component|Static|Debug]

npm run sync -- [--force] [--init] [--create] [brave_core_ref]

This will attempt to stash your local changes in brave-core, but it's safer to commit local changes before running this

npm run sync will (depending on the below flags):

1. 📥 Update sub-projects (chromium, brave-core) to latest commit of a git ref (e.g. tag or branch)
2. 🤕 Apply patches
3. 🔄 Update gclient DEPS dependencies
4. ⏩ Run hooks (e.g. to performnpm install on child projects)

Runnpm run sync brave_core_ref to checkout the specifiedbrave-core ref and update all dependent repos including chromium if needed.

brave-browser>cd src/bravebrave-browser/src/brave> git checkout -b branch_name

brave-browser/src/brave> git fetch originbrave-browser/src/brave> git checkout [-b] branch_namebrave-browser/src/brave> npm run sync...Updating 2 patches......Updating child dependencies......Running hooks...

brave-browser/src/brave> git pullbrave-browser/src/brave> npm run sync...Updating 2 patches......Updating child dependencies......Running hooks...

brave-browser> git checkout masterbrave-browser> git pullbrave-browser> npm run sync -- --init

brave-browser/src/brave> git checkout featureBbrave-browser/src/brave> git pullbrave-browser/src/brave>cd ../..brave-browser> npm run apply_patches...Applying 2 patches...

1. Google Safe Browsing: Get an API key with SafeBrowsing API enabled fromhttps://console.developers.google.com/. Update theGOOGLE_API_KEY environment variable with your key as perhttps://www.chromium.org/developers/how-tos/api-keys to enable Google SafeBrowsing.

• Security rules from Chromium
• IPC review guidelines (in particularthis reference)
• Brave's internal security guidelines (for employees only)
• Rust usage

SeeTroubleshooting for solutions to common problems.