Gradle Android

Add this line to your build.gradle file:

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

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

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

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

android {
    compileSdk 33
        defaultConfig {
             ...
             targetSdk 33
             ...
        }
        ...
}

Code

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

Java

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

Kotlin

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

Optional Settings

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

Java

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

Kotlin

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

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

Java

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

Kotlin

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

Want to know more

Swift Package Manager (Recommended)

To integrate ShakeBug into your Xcode project using Swift Package Manager, add the repository URL below in Xcode under File > Add Package Dependencies...

https://github.com/softnoesis/ShakeBug/

Choose version 1.0.44 or later and add the package to your app target.

https://github.com/softnoesis/ShakeBug/releases/tag/1.0.44

Note: Latest version of Shakebug iOS SDK is 1.0.44. Open Detail

Code

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

Swift

import ShakeBug

Objective-C

#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.

Swift

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

Objective-C

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

3. Add the following to your Info.plist to request permission to access the Photo Library.

<dict>
<key>NSPhotoLibraryUsageDescription</key>
<string>Require access for reporting bugs.</string>
</dict>

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

npm

Navigate to your React Native project directory and install shakebug-react-native

npm install shakebug-react-native

Or if you prefer to use Yarn instead of npm:

yarn add shakebug-react-native

Want to know more

Add the Shakebug package

Add Shakebug to your Flutter project from pub.dev — run this in your project root:

flutter pub add shakebug

Or add it manually to your pubspec.yaml (see pub.dev for the latest version):

dependencies:
shakebug: ^1.0.6

Usage

1. Import the Shakebug package:

import 'package:shakebug/shakebug.dart';

2. Wrap your app with ShakebugSDK and pass your Android and iOS app keys from your Shakebug dashboard:

ShakebugSDK(
  androidAppKey: 'your_android_appkey',
  iosAppKey: 'your_ios_appkey',
  child: MaterialApp(
    home: const HomeScreen(),
  ),
);

3. Build and run, then shake the device to report a bug. Shake-to-report is enabled by default.

Want to know more? Open the full Flutter guide

JavaScript SDK (NPM)

We no longer support the legacy JavaScript snippet. For modern web projects, use our official NPM package.

This package is suitable for React, Next.js, Express.js, and other JavaScript-based frameworks or applications.

Install with NPM

npm install @softnoesis/shakebug-js

Or, if you prefer Yarn:

yarn add @softnoesis/shakebug-js

Usage

1. Import the Shakebug stylesheet once — for example in your root component or app entry file:

import '@softnoesis/shakebug-js/dist/index.css';

2. Add the Shakebug component near the root of your app, using the App Key and Website URL from your Shakebug dashboard:

import { Shakebug } from '@softnoesis/shakebug-js';

function App() {
  return (
    <div>
      <Shakebug
        appKey="YOUR_APP_KEY"
        bundleId="YOUR_WEBSITE_URL"
        showFloatingButton={true}
      />
      {/* Your app content */}
    </div>
  );
}

Works with React, Next.js, and other JavaScript frameworks. Set showFloatingButton to false if you prefer to trigger the reporter only with the keyboard shortcut below.

3. Power users can open the bug reporter from anywhere on your site with a global keyboard shortcut — for example to report a bug without reaching for the mouse:

macOS — Cmd + Alt + K
Windows — Ctrl + Alt + K
Linux — Ctrl + Alt + K

Next steps

Use the app key from your Shakebug dashboard and follow our detailed web integration guide to complete setup in your project.

Want to know more? Open the full Web SDK guide

Google Chrome Extension

You can seamlessly integrate Shakebug into your web project using our Google Chrome Extension:

First, ensure that the URL of your website is added to your Shakebug account. Log in to your Shakebug account and navigate to the project page to add your website URL.

Next, install the Shakebug Chrome Extension from the Chrome Web Store.

After installation, click on the Shakebug Extension icon in your browser's toolbar. That new icon/tool will allow you to report bugs directly from your Chrome browser.

WordPress Plugin

Add Shakebug to any WordPress site with our official plugin — no code required. It captures bug reports with annotated screenshots, screen recordings, console logs, crashes, and user sessions straight from your site.

Install from your dashboard

In WordPress admin, open Plugins → Add New, search for “Shakebug”, then click Install Now and Activate. You can also download it from wordpress.org/plugins/shakebug and upload the zip via Plugins → Add New → Upload Plugin.

Connect your project

Open Shakebug in your WordPress admin sidebar and paste your API key from your Shakebug dashboard. Don’t have an account yet? Create one free. Reports then flow into your Shakebug project automatically.

Requirements: WordPress 6.0 or higher and PHP 7.4+.

View the plugin on WordPress.org