You are looking at the user documentation for the most recent master branch of RepoSense (not released to the public yet). The documentation for the latest public release is here.

Generating a report

Let's look at different ways to generate RepoSense reports.

  • If you have Java on your computer, the straight-forward way to generate a report is to use the RepoSense executable to generate the report locally on your computer, as explained in the Generating reports locally section below.

  • If you don't have Java on your computer or do not wish to run the executable on your computer, some alternatives are provided in the Generating reports remotely section below.

Generating reports locally

  1. Ensure you have the prerequisites:

    • Java 8 (JRE 1.8.0_60) or later (download ).
    • git 2.14 or later on the command line. (download ).
      run git --version in your OS terminal to confirm the version.
  2. Download the latest JAR file from our releases.

  3. Generate a report: The simplest use case for RepoSense is to generate a report for the recent history of a repo.
    command: java -jar RepoSense.jar --repos LIST_OF_REPO_URLS --view
    Examples:

    • java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --view (note the .git at the end of the repo URL)
    • java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar --view analyzes the two specified repos (one remote, one local).

    The above commands will analyze the given repo(s) for commits done within the last month and open the report in your default Browser.

To learn how to generate a report using e.g., generate a report for a different period, for specific file types, for specific authors, etc.other settings, head over to the Customizing reports section.

Generating reports remotely

You can generate a RepoSense report remotely without installing/running anything on your computer. This is particularly useful when you are deciding whether to adopt RepoSense.

The easiest option is to use Netlify. The instructions are given below.

You can also use the following options. While they are more work to set up, they are more suitable as a permanent solution due to their generous free tier.