Sherlock

KO | EN

gitlite — search

#javascript #python #react #typescript #golang #machine-learning #docker #nodejs #windows #awesome #kubernetes #pytorch #security #ios

(★ 103)

Sherlock reports any crash that occurs in your application

File Explorer

Download Latest Version (.zip)

- - gradle-wrapper.jar
  - gradle-wrapper.properties
- maven-push.gradle
- publish.gradle
- .gitignore
- build.gradle
- gradle.properties
- proguard-rules.pro
- .gitignore
- build.gradle
- gradle.properties
- proguard-rules.pro
.gitignore
.travis.yml
build.gradle
CODE_OF_CONDUCT.md
CONTRIBUTING.md
gradle.properties
gradlew
gradlew.bat
LICENSE.txt
README.md
settings.gradle

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Sherlock
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/ajitsing/Sherlock/graphs/commit-activity)
[![Build Status](https://travis-ci.org/ajitsing/Sherlock.svg?branch=master)](https://travis-ci.org/ajitsing/Sherlock)
[![HitCount](http://hits.dwyl.io/ajitsing/Sherlock.svg)](http://hits.dwyl.io/ajitsing/Sherlock)
[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=102)](https://opensource.org/licenses/Apache-2.0)
[![Maven Central](https://img.shields.io/maven-central/v/com.github.ajitsing/sherlock.svg)](https://mvnrepository.com/artifact/com.github.ajitsing/sherlock)
![API](https://img.shields.io/badge/API-16%2B-blue.svg)
[![Twitter Follow](https://img.shields.io/twitter/follow/Ajit5ingh.svg?style=social)](https://twitter.com/Ajit5ingh)

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

## Motivation
The motivation behind creating Sherlock is to make the life of Developer and tester easier. Whenever a tester is testing
the app and he/she encounters a crash, most of the time they don't have enough details in their hand to enable developer to
start fixing the crash immediately. Now with the help of Sherlock, any tester will have enough info to report the crash.

![Alt text](https://github.com/ajitsing/ScreenShots/blob/master/sherlock/sherlock_demo.gif)

## Demo
[![](https://github.com/ajitsing/ScreenShots/blob/master/sherlock/sherlock_youtube.png)](https://www.youtube.com/watch?v=cEQBJkTeRUQ "Demo")

## Installation
```groovy
debugCompile('com.github.ajitsing:sherlock:1.0.4@aar') {
    transitive = true
}
releaseCompile('com.github.ajitsing:sherlock-no-op:1.0.4@aar')
```

## Usage
To start using Sherlock just add the below line in the ```onCreate()``` method of Application class.

```java
public class MyApplication extends Application {
  @Override
  public void onCreate() {
    super.onCreate();
    Sherlock.init(this); //Initializing Sherlock
  }
}
```

Once you add ```Sherlock.init(this)``` Sherlock will take care of reporting all the crashes to you.

### See All Crashes
You can view all the crashes by starting the ```CrashListActivity```.

### Get All Crashes Captured By Sherlock
Sherlock also provides you a way to get all the crashes which are reported by Sherlock in form of java object. You can get them
using below line of code.
```java
Sherlock.getInstance().getAllCrashes()
```
Before accessing ```getInstance()``` make sure that you have initialized Sherlock, otherwise it will throw ```SherlockNotInitializedException```.

### App Info
By default Sherlock only captures the version of your application and shows that as part of crash details. If you want to
provide some extra details regarding app, you can do so by providing an AppInfoProvider to the Sherlock.

```java
Sherlock.setAppInfoProvider(new AppInfoProvider() {
  @Override
  public AppInfo getAppInfo() {
    return new AppInfo.Builder()
               .with("Version", "2.21") //You can get the actual version using "AppInfoUtil.getAppVersion(context)"
               .with("BuildNumber", "221B")
               .build();
  }
});
```

## Contributing
You can contribute to Sherlock by forking the repo and creating pull requests. You can also contribute by reporting bugs/issues.
If you want to see a new feature in Sherlock, just add that as an issue with enough details.

LICENSE
-------

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

Sherlock

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Sherlock

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README