https://github.com/instabug/instabug-ios
In-app feedback and bug reporting tool for apps.
https://github.com/instabug/instabug-ios
bug-reporter bug-reporting instabug ios-sdk
Last synced: 3 months ago
JSON representation
In-app feedback and bug reporting tool for apps.
- Host: GitHub
- URL: https://github.com/instabug/instabug-ios
- Owner: Instabug
- License: other
- Created: 2013-10-14T03:15:04.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-03-16T12:41:37.000Z (3 months ago)
- Last Synced: 2025-04-01T08:32:16.729Z (3 months ago)
- Topics: bug-reporter, bug-reporting, instabug, ios-sdk
- Language: Ruby
- Homepage: https://instabug.com/
- Size: 3.7 GB
- Stars: 295
- Watchers: 60
- Forks: 67
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Instabug iOS SDK
Instabug is an in-app feedback and bug reporting tool for mobile apps. With just a simple shake, your users or beta testers can [report bugs](https://instabug.com/bug-reporting) or send in-app feedback and the SDK will capture an environment snapshot of your user's device including all console logs, [server-side network requests](https://instabug.com/network-logging) and bug reproduction steps compiling all these details in one organised dashboard to help you debug and fix bugs faster.
Instabug also provides you with a [reliable crash reporter](https://instabug.com/crash-reporting) that automatically captures a detailed report of the running environment, the different threads’ states, [the steps to reproduce the crash](https://instabug.com/user-steps), and the network request logs. All the data is captured automatically with no need for breadcrumbs, and you can always [reply back to your users](https://instabug.com/in-app-chat) and they will receive your messages within the app.
For more info, visit [Instabug.com](https://www.instabug.com).
## Installation
### CocoaPods
To integrate Instabug into your Xcode project using [CocoaPods](https://cocoapods.org), add it to your `Podfile`:
```ruby
pod 'Instabug'
```
Then, run the following command:
```bash
$ pod install
```
### Carthage
To integrate Instabug into your Xcode project using [Carthage](https://github.com/Carthage/Carthage), add it to your `Cartfile`:
```
binary "https://raw.githubusercontent.com/Instabug/Instabug-iOS/master/Instabug.json"
```
Then, run the following command:
```bash
$ carthage update
```
Then drag Instabug.framework into your Xcode project.
### Swift Package Manager
To integrate Instabug into your Xcode project using SPM, please refer to https://github.com/Instabug/Instabug-SP
### Manually
Follow these steps to integrate the Instabug SDK into your iOS project:
1. **Download the Latest Instabug SDK Release:**
- [Go to Instabug SDK latest release](https://github.com/Instabug/Instabug-iOS/releases/latest)
- Click on `Instabug-XCFramework.zip` to download the file.
2. **Extract the Zip File:**
- Unzip the downloaded file to reveal the `Instabug.xcframework`.
3. **Add the Framework to Your Project:**
- Open your project in Xcode.
- Navigate to your project's **General** tab.
- Scroll down to the **Frameworks, Libraries, and Embedded Content** section.
- Click the `+` button, then select **Add Files**.
- Choose the `Instabug.xcframework` from the extracted folder, then click **Open**.
4. **Set Embed Option:**
- In the **Embed** column next to `Instabug.xcframework`, select `Embed Without Signing`.
## Usage
1. Import Instabug framework header in your app delegate
```swift
// Swift
import Instabug
```
```objective-c
// Objective-C
#import
```
2. Add the following to your app delegate's application:didFinishLaunchingWithOptions: method.
```swift
// Swift
Instabug.start(withToken: <#app token#>, invocationEvents: .shake)
```
```objective-c
// Objective-C
[Instabug startWithToken:<#app token#> invocationEvents:IBGInvocationEventShake];
```
Make sure to replace `app_token` with your application token. Find it [here](https://instabug.com/app/sdk/).
## Notes
Instabug needs access to the microphone and photo library to be able to let users add audio and video attachments. Starting from iOS 10, apps that don’t provide a usage description for those 2 permissions would be rejected when submitted to the App Store.
For your app not to be rejected, you’ll need to add the following 2 keys to your app’s info.plist file with text explaining to the user why those permissions are needed:
* `NSMicrophoneUsageDescription`
* `NSPhotoLibraryUsageDescription`
If your app doesn’t already access the microphone or photo library, we recommend using a usage description like:
* "`` needs access to the microphone to be able to attach voice notes."
* "`` needs access to your photo library for you to be able to attach images."
**The permission alert for accessing the microphone/photo library will NOT appear unless users attempt to attach a voice note/photo while using Instabug.**
## More
You can also check out our [API Reference](https://docs.instabug.com/docs/ios-overview) for more detailed information about our SDK.