Awesome Open Source
Awesome Open Source
The BugShaker logo

Shake to send a bug report!

Build Status Download Android Arsenal

Development Status


  • Not currently under active development.
  • Active development may resume in the future.
  • Bug reports will be triaged and fixed. No guarantees are made regarding fix timelines.
  • Feature requests will be triaged. No guarantees are made regarding acceptance or implementation timelines.
  • Pull requests from external contributors are not currently being accepted.


BugShaker allows your QA team and/or end users to easily submit bug reports by shaking their device. When a shake is detected, the current screen state is captured and the user is prompted to submit a bug report via email with this screenshot attached.

This library is similar to Telescope, but aims to be even easier to integrate into your apps and workflows:

  • all configuration occurs in your custom Application subclass (no view hierarchy alterations required);
  • no need to request extra permissions;
  • iOS version of this library is already available (based on the same shake-to-send mechanism).


Prompt Email

Play Store Demo App

Getting Started

  1. Specify BugShaker-Android as a dependency in your build.gradle file:

    dependencies {
  2. Configure the shared BugShaker instance in your custom Application class, then call assemble and start to begin listening for shakes:

    public class CustomApplication extends Application {
        public void onCreate() {
                     .setEmailAddresses("[email protected]")   // required
                     .setEmailSubjectLine("Custom Subject Line") // optional
                     .setAlertDialogType(AlertDialogType.NATIVE) // optional
                     .setLoggingEnabled(BuildConfig.DEBUG)       // optional
                     .setIgnoreFlagSecure(true)                  // optional
                     .assemble()                                 // required
                     .start();                                   // required

It is recommended that logging always be disabled in production builds.

Advanced Usage

If you would like to customize the alert dialog presented to users when a shake is detected, update your BugShaker configuration as follows:

  • Remove any setAlertDialogType calls;
  • Add a call to setCustomDialogProvider, passing in your own DialogProvider instance.


Copyright 2016 Stuart Kent

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Java (706,068
Android (40,484
Android Library (3,275
Feedback (362
Bug (306
Bug (306
Related Projects