{"id":13989198,"url":"https://github.com/ajitsing/Sherlock","last_synced_at":"2025-07-22T10:31:30.611Z","repository":{"id":54775077,"uuid":"87966671","full_name":"ajitsing/Sherlock","owner":"ajitsing","description":"Sherlock reports any crash that occurs in your application","archived":false,"fork":false,"pushed_at":"2018-10-14T11:28:28.000Z","size":256,"stargazers_count":102,"open_issues_count":3,"forks_count":25,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-06-21T05:07:51.466Z","etag":null,"topics":["android","android-library","crash-dump","crash-reporting","crash-reporting-tool","crash-reports","library","sherlock"],"latest_commit_sha":null,"homepage":"http://www.singhajit.com/integrating-sherlock-with-android-apps-to-get-crash-reports/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ajitsing.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-04-11T18:30:38.000Z","updated_at":"2025-01-21T20:48:10.000Z","dependencies_parsed_at":"2022-08-14T02:31:05.137Z","dependency_job_id":null,"html_url":"https://github.com/ajitsing/Sherlock","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/ajitsing/Sherlock","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajitsing%2FSherlock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajitsing%2FSherlock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajitsing%2FSherlock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajitsing%2FSherlock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ajitsing","download_url":"https://codeload.github.com/ajitsing/Sherlock/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajitsing%2FSherlock/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266475111,"owners_count":23934884,"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","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["android","android-library","crash-dump","crash-reporting","crash-reporting-tool","crash-reports","library","sherlock"],"created_at":"2024-08-09T13:01:33.408Z","updated_at":"2025-07-22T10:31:29.945Z","avatar_url":"https://github.com/ajitsing.png","language":"Java","funding_links":[],"categories":["Java","Crash Monitoring"],"sub_categories":[],"readme":"# Sherlock\n[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/ajitsing/Sherlock/graphs/commit-activity)\n[![Build Status](https://travis-ci.org/ajitsing/Sherlock.svg?branch=master)](https://travis-ci.org/ajitsing/Sherlock)\n[![HitCount](http://hits.dwyl.io/ajitsing/Sherlock.svg)](http://hits.dwyl.io/ajitsing/Sherlock)\n[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=102)](https://opensource.org/licenses/Apache-2.0)\n[![Maven Central](https://img.shields.io/maven-central/v/com.github.ajitsing/sherlock.svg)](https://mvnrepository.com/artifact/com.github.ajitsing/sherlock)\n![API](https://img.shields.io/badge/API-16%2B-blue.svg)\n[![Twitter Follow](https://img.shields.io/twitter/follow/Ajit5ingh.svg?style=social)](https://twitter.com/Ajit5ingh)\n\nSherlock reports any crash that occurres in your application as a notification. You just need to initialize Sherlock at the start of your application and it will take care of the rest. \n\n## Motivation\nThe motivation behind creating Sherlock is to make the life of Developer and tester easier. Whenever a tester is testing\nthe app and he/she encounters a crash, most of the time they don't have enough details in their hand to enable developer to\nstart fixing the crash immediately. Now with the help of Sherlock, any tester will have enough info to report the crash.\n\n\n![Alt text](https://github.com/ajitsing/ScreenShots/blob/master/sherlock/sherlock_demo.gif)\n\n## Demo\n[![](https://github.com/ajitsing/ScreenShots/blob/master/sherlock/sherlock_youtube.png)](https://www.youtube.com/watch?v=cEQBJkTeRUQ \"Demo\")\n\n## Installation\n```groovy\ndebugCompile('com.github.ajitsing:sherlock:1.0.4@aar') {\n    transitive = true\n}\nreleaseCompile('com.github.ajitsing:sherlock-no-op:1.0.4@aar')\n```\n\n## Usage\nTo start using Sherlock just add the below line in the ```onCreate()``` method of Application class.\n\n```java\npublic class MyApplication extends Application {\n  @Override\n  public void onCreate() {\n    super.onCreate();\n    Sherlock.init(this); //Initializing Sherlock\n  }\n}\n```\n\nOnce you add ```Sherlock.init(this)``` Sherlock will take care of reporting all the crashes to you.\n\n### See All Crashes\nYou can view all the crashes by starting the ```CrashListActivity```.\n\n### Get All Crashes Captured By Sherlock\nSherlock also provides you a way to get all the crashes which are reported by Sherlock in form of java object. You can get them\nusing below line of code.\n```java\nSherlock.getInstance().getAllCrashes()\n```\nBefore accessing ```getInstance()``` make sure that you have initialized Sherlock, otherwise it will throw ```SherlockNotInitializedException```.\n\n### App Info\nBy default Sherlock only captures the version of your application and shows that as part of crash details. If you want to\nprovide some extra details regarding app, you can do so by providing an AppInfoProvider to the Sherlock.\n\n```java\nSherlock.setAppInfoProvider(new AppInfoProvider() {\n  @Override\n  public AppInfo getAppInfo() {\n    return new AppInfo.Builder()\n               .with(\"Version\", \"2.21\") //You can get the actual version using \"AppInfoUtil.getAppVersion(context)\"\n               .with(\"BuildNumber\", \"221B\")\n               .build();\n  }\n});\n```\n\n## Contributing\nYou can contribute to Sherlock by forking the repo and creating pull requests. You can also contribute by reporting bugs/issues.\nIf you want to see a new feature in Sherlock, just add that as an issue with enough details.\n\nLICENSE\n-------\n\n```LICENSE\nCopyright (C) 2017 Ajit Singh\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajitsing%2FSherlock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fajitsing%2FSherlock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajitsing%2FSherlock/lists"}