{"id":20789255,"url":"https://github.com/instabug/instabug-ios","last_synced_at":"2025-04-08T09:09:54.720Z","repository":{"id":11175530,"uuid":"13551558","full_name":"Instabug/Instabug-iOS","owner":"Instabug","description":"In-app feedback and bug reporting tool for apps.","archived":false,"fork":false,"pushed_at":"2025-03-16T12:41:37.000Z","size":3977584,"stargazers_count":295,"open_issues_count":9,"forks_count":67,"subscribers_count":60,"default_branch":"master","last_synced_at":"2025-04-01T08:32:16.729Z","etag":null,"topics":["bug-reporter","bug-reporting","instabug","ios-sdk"],"latest_commit_sha":null,"homepage":"https://instabug.com/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Instabug.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-10-14T03:15:04.000Z","updated_at":"2025-03-16T12:41:40.000Z","dependencies_parsed_at":"2023-02-17T21:45:21.053Z","dependency_job_id":"d32977df-3833-4e4b-a376-d445951e3682","html_url":"https://github.com/Instabug/Instabug-iOS","commit_stats":null,"previous_names":[],"tags_count":302,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Instabug%2FInstabug-iOS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Instabug%2FInstabug-iOS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Instabug%2FInstabug-iOS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Instabug%2FInstabug-iOS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Instabug","download_url":"https://codeload.github.com/Instabug/Instabug-iOS/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247809964,"owners_count":20999816,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bug-reporter","bug-reporting","instabug","ios-sdk"],"created_at":"2024-11-17T15:21:37.567Z","updated_at":"2025-04-08T09:09:54.695Z","avatar_url":"https://github.com/Instabug.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Instabug iOS SDK\n![CocoaPods Compatible](https://img.shields.io/cocoapods/v/Instabug.svg)\n![Twitter](https://img.shields.io/badge/twitter-@Instabug-blue.svg)\n\nInstabug 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. \n\nInstabug 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.\n\nFor more info, visit [Instabug.com](https://www.instabug.com).\n\n## Installation\n\n### CocoaPods\n\nTo integrate Instabug into your Xcode project using [CocoaPods](https://cocoapods.org), add it to your `Podfile`:\n\n```ruby\npod 'Instabug'\n```\n\nThen, run the following command:\n\n```bash\n$ pod install\n```\n\n### Carthage\n\nTo integrate Instabug into your Xcode project using [Carthage](https://github.com/Carthage/Carthage), add it to your `Cartfile`:\n\n```\nbinary \"https://raw.githubusercontent.com/Instabug/Instabug-iOS/master/Instabug.json\"\n```\n\nThen, run the following command:\n\n```bash\n$ carthage update\n```\n\nThen drag Instabug.framework into your Xcode project.\n\n### Swift Package Manager\n\nTo integrate Instabug into your Xcode project using SPM, please refer to https://github.com/Instabug/Instabug-SP\n\n### Manually\n\nFollow these steps to integrate the Instabug SDK into your iOS project:\n\n1. **Download the Latest Instabug SDK Release:**\n   - [Go to Instabug SDK latest release](https://github.com/Instabug/Instabug-iOS/releases/latest)\n   - Click on `Instabug-XCFramework.zip` to download the file.\n\n2. **Extract the Zip File:**\n   - Unzip the downloaded file to reveal the `Instabug.xcframework`.\n\n3. **Add the Framework to Your Project:**\n   - Open your project in Xcode.\n   - Navigate to your project's **General** tab.\n   - Scroll down to the **Frameworks, Libraries, and Embedded Content** section.\n   - Click the `+` button, then select **Add Files**.\n   - Choose the `Instabug.xcframework` from the extracted folder, then click **Open**.\n\n4. **Set Embed Option:**\n   - In the **Embed** column next to `Instabug.xcframework`, select `Embed Without Signing`.\n\n## Usage\n\n1. Import Instabug framework header in your app delegate\n\n    ```swift\n    // Swift\n    import Instabug\n    ```\n    \n    ```objective-c\n    // Objective-C\n    #import \u003cInstabug/Instabug.h\u003e\n    ```\n\n2. Add the following to your app delegate's application:didFinishLaunchingWithOptions: method.\n    \n    ```swift\n    // Swift\n    Instabug.start(withToken: \u003c#app token#\u003e, invocationEvents: .shake)\n    ```\n    ```objective-c\n    // Objective-C\n    [Instabug startWithToken:\u003c#app token#\u003e invocationEvents:IBGInvocationEventShake];\n    ```\n    Make sure to replace `app_token` with your application token. Find it [here](https://instabug.com/app/sdk/).\n\n## Notes\nInstabug 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.\n\nFor 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:\n\n* `NSMicrophoneUsageDescription`\n* `NSPhotoLibraryUsageDescription`\n\nIf your app doesn’t already access the microphone or photo library, we recommend using a usage description like:\n\n* \"`\u003capp name\u003e` needs access to the microphone to be able to attach voice notes.\"\n* \"`\u003capp name\u003e` needs access to your photo library for you to be able to attach images.\"\n\n**The permission alert for accessing the microphone/photo library will NOT appear unless users attempt to attach a voice note/photo while using Instabug.**\n    \n## More\n\nYou can also check out our [API Reference](https://docs.instabug.com/docs/ios-overview) for more detailed information about our SDK.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstabug%2Finstabug-ios","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finstabug%2Finstabug-ios","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstabug%2Finstabug-ios/lists"}