Quick Start Guide

Installation and setup takes less than 5 minutes. No credit card or sign-up required to start working better, together.

System Requirements

Mac, Linux or Windows machine with docker installed. Don't have docker, no problem. Docker is free and can be easily installed on Mac, Linux and Windows. To learn more, please visit the official Get Docker page.

Step 1

Download and install GitSense with the docker run command.

docker run \
    --rm \
    --detach \
    --name gitsense \
    --volume gitsense:/opt \
    --publish 3347:3347 \
    gitsense/insights

Step 2

Define an access token so GitSense can index private repositories and make GitHub API calls with higher rate limits.

GitHub

For instructions on how to create an access token with repo privilege, please refer to GitHub's official access token document or watch the quick start video.

Syntax:
    docker exec -ti gitsense set-token github <token>
                               
Example:
    docker exec -ti gitsense set-token github fec8ccf954c093d905dc84691f4484005641cf26

Bitbucket and GitLab

Support coming soon.

Step 3

Add one or more repositories to index.

GitHub

Syntax:
    docker exec -ti gitsense add-repo github <owner> <name>
                                
Examples:
    docker exec -ti gitsense add-repo github github super-linter
    docker exec -ti gitsense add-repo github vuejs vue

Bitbucket and GitLab

Support coming soon.

SUCCESS!

GitSense is now up and running and can be accessed on port 3347 on your docker host. For example, if the IP address for the machine that docker is installed on is 192.168.0.1, you can access GitSense at http://192.168.0.1:3347

Note
Indexing can take minutes to hours to complete depending on the repository size and hardware that docker is running on. To track indexing progress, login to the GitSense admin tool with the username: admin and password: admin at http://<your docker host>:3347/admin