We use cookies to ensure you get the best user experience on our website.Find Out More

Gradle Android

Add this line to your build.gradle file:

implementation 'com.softnoesis.shakebug:ShakeBug:1.2.32'

You may also need to add the following to your project/build.gradle file:

buildscript {
    repositories {
        maven { url 'https://jitpack.io' }

Then, update the following sdkVersion to your app's `build.gradle` file:

android {
    compileSdk 33
        defaultConfig {
             targetSdk 33


1. In your Launching activity add this line to your onCreate method. This initializes Shake Bug with the default invocation event, Shake.


ShakeBug.sharedInstance().initiateWithKey(this, "<Your Key>");


ShakeBug.sharedInstance().initiateWithKey(this,"<Your Key>")

Optional Settings

1. If you want add event to any screen or activity use following methods.


ShakeBug.sharedInstance().addEventKey(this,"<Key>","<Key Value>");//pass any key or value


ShakeBug.sharedInstance().addEventKey(this,"<Key>","<Key Value>") // pass any key or value

2. Add the following for enabling/disabling first time tutorial screen.


ShakeBug.sharedInstance().showTutorialScreenFirstTime(true); // Default value True


ShakeBug.sharedInstance().showTutorialScreenFirstTime(true) // Default value True

Want to know more
CocoaPods IOS

To integrate ShakeBug into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'ShakeBug'

Then, run the following command:

$ pod install

1. Import the ShakeBug framework header into your app delegate.


import ShakeBug


#import< ShakeBug/ShakeBug.h>

Note: If you are working React Native exported project then you also need to mention this line too

#import <ShakeBug/ShakeBug-Swift.h>

2. Add the following to your app delegate's application:didFinishLaunchingWithOptions: method.


ShakeBugSDK.sharedInstance().initiate(withKey: "Your Key")


[[ShakebugSDK sharedInstance] initiateWithKey: "Your Key"];

Be sure to replace with your application key which given by ShakeBug website.

Note: NSPhotoLibraryUsageDescription must be added in info.plist.

Want to know more
React Native-IOS

For iOS project, developer must need to install Shakebug in xCode project using pod.

To install Shakebug SDK in xCode project. Please follow above "For iOS" guide.

React Native-Android

Add this line to your build.gradle file.

implementation ("com.softnoesis.shakebug:ShakeBug:1.2.28")

Open package having MainActivity.java file and create ShakeBugModule.java

import com.softnoesis.shakebuglibrary.ShakeBug; // this
    protected void onCreate(Bundle savedInstanceState) {
       ShakeBug.sharedInstance().initiateWithKey(this, “”); //this

Want to know more

Copy following code after the </body> section of your HTML.

<!-- Shakebug.com - shakebug.js -->
<script type="text/javascript" src="https://www.shakebug.com/assets/js/shakebug-min-1.0.js" id="apikey" isReportingIconVisible="false" isAllowshake="false" apikey="replace your key">

Use cases:

1. Make sure this script must be load in each and every page of your website.

2. Here value of apikey must be from Shakebug after login panel.

3. isReportingIconVisible = true means it will show bug reporting icon in left-bottom corner of your website.
False means it won’t show icon there.

4. To enable bug reporting using the shake gesture on an iOS mobile device, ensure that 'isAllowShake' is set to true in the above script.
False means it won’t allow shake gesture in ios mobile device.

5. Shortcut key for bug reporting in Desktop website:
For Windows and Ubuntu OS:

Control + Alt + k

For Mac OS:

Command + Option + k

To add an events:

Prior to add event to any webpage, you must need to add following script below the above script.

<!-- Shakebug.com - Add events to any webpage. -->
<script> addShakebugEvent("key","value"); </script>
Compatible Browsers:
Browser Desktop iOS Android
Google Chrome
Mozilla Firefox
Microsoft Edge

Start saving time now!

Sign up free

No credit card required