This guide describes how to distribute APKs to testers using the Firebase CLI. The CLI tool lets you specify testers and release notes for a build, then distributes the build accordingly.
Before you begin
If you haven't already, add Firebase to your Android project.
If you aren't using any other Firebase products, you only have to create a project and register your app. However, if you decide to use additional products in the future, be sure to complete all of the steps on the page linked above.
Step 1. Build your app
When you're ready to distribute a pre-release version of your app to testers, build your APK using your normal process. You must sign the APK with your debug key or app signing key.
Step 2. Distribute your app to testers
To distribute your app to testers, upload your app's file using the Firebase CLI:
- Install or update to the latest version of the Firebase CLI (we recommend downloading the standalone binary for the CLI specific to your OS). Make sure to sign in and test that you can access your projects.
- In the App Distribution page of the Firebase console, select the app you want to distribute, then click Get started.
appdistribution:distributecommand to upload your app and distribute it to testers. Use the following parameters to configure the distribution:
Required: Your app's Firebase App ID. You can find the App ID in the Firebase console, on the General Settings page.
A refresh token that's printed when you authenticate your CI environment with the Firebase CLI (read Use the CLI with CI systems for more information).
Release notes for this build.
You can either specify the release notes directly:
--release-notes "Text of release notes"
Or, specify the path to a plain text file:
The email addresses of the testers you want to invite.
You can specify the testers as a comma-separated list of email addresses:
--testers "firstname.lastname@example.org, email@example.com, firstname.lastname@example.org"
Or, you can specify the path to a plain text file containing a comma-separated list of email addresses:
The tester groups you want to invite (refer to Manage testers). Groups are specified using
group aliases, which you can look up in the Firebase console.
You can specify the groups as a comma-separated list:
--groups "qa-team, trusted-testers"
Or, you can specify the path to a plain text file containing a comma-separated list of group names:
A flag you can include to print verbose log output.
firebase appdistribution:distribute test.apk \ --app 1:1234567890:android:0a1b2c3d4e5f67890 \ --release-notes "Bug fixes and improvements" --testers-file testers.txt
The Firebase CLI outputs the following links after the release upload. These links help you manage binaries and ensure that testers and other developers have the right release:
firebase_console_uri- A link to the Firebase console displaying a single release. You can share this link with other developers in your org.
testing_uri- A link to the release in the tester experience (Android native app) that lets testers view release notes and install the app onto their device. The tester needs access to the release in order to use the link.
binary_download_uri- A signed link that directly downloads and installs the app binary (APK or AAB file) . The link expires after one hour.
Manage testers and groups
In addition to distributing releases, you can also use
appdistribution:testers:removeto invite new testers or remove existing testers from your Firebase project.
Once a tester has been added to your Firebase project, you can add them to individual releases. Once you remove a tester, they will no longer have access to releases in your project. Note that testers who are recently removed can still retain access to your releases for a window of time.
firebase appdistribution:testers:add email@example.com firstname.lastname@example.org
firebase appdistribution:testers:remove email@example.com firstname.lastname@example.org
Tester emails must be separated by a space. You can also specify testers using
If you have a large number of testers you should consider using groups: You can use
appdistribution:group:deleteto create or delete groups in your Firebase project.
--group-aliasto specify a group for the
firebase appdistribution:group:create "QA team" qa-team
firebase appdistribution:testers:add --group-alias=qa-team email@example.com firstname.lastname@example.org
firebase appdistribution:testers:remove --group-alias=qa-team email@example.com firstname.lastname@example.org
firebase appdistribution:group:delete qa-team
Once you distribute your build, it becomes available in the App Distribution dashboard of the Firebase console for 150 days (five months). When the build is 30 days from expiring, an expiration notice appears in both the console and your tester's list of builds on their test device.
Testers who haven't been invited to test the app receive email invitations to get started, and existing testers receive email notifications that a new build is ready to test (read the tester set up guide for instructions on how to install the test app). You can monitor the status of each tester-whether they accepted the invitation and whether they downloaded the app-in the Firebase console.
Testers have 30 days to accept an invitation to test the app before it expires. When an invitation is 5 days from expiring, an expiration notice appears in the Firebase console next to the tester on a release. An invitation can be renewed by resending it using the drop-down menu on the tester row.
Implement in-app feedback to make it easy for testers to send feedback about your app (including screenshots).
Learn how to display in-app alerts to your testers when new builds of your app are available to install.
Learn best practices for distributing Android apps to QA testers using CI/CD.