README.md

Heimdallr

Keep watch over all your project(s) PRs.

Features

• Helps you keep track of activity over many repositories
• Provides quick access to each PR, select one and hit Enter to open it in your default browser
• Keeps track of which activity you've reviewed per PR, including your activity outside of heimdallr.
• Shows reviewers and their status
  • Green for Approved
  • Yellow for Not Reviewed
  • Red for Needs Work

Usage

First create your config (~/.heimdallrconfig.json). For the token, create a "Personal Access Token" in your profile page.

{
    "pageSize": 25, 
    "refreshIntervalMinutes": 15,
    "sources": [
        {
            "type": "bitbucket",
            "baseUrl": "https://some.bitbucket.url/rest/api/1.0",
            "email": "some@email.com",
            "token": "YOUR-TOKEN",
            "projects": [
                "Project1",
                "Project2"
            ],
            "repositories": [
                {"project": "ExternalProject", "repository": "ExternalRepo"},
                {"project": "AnotherExternalProject", "repository": "AnotherExternalRepo"}
            ]
        },
        {
            "type": "github",
            "username": "SomeUsername",
            "token": "YOUR-TOKEN",
            "repositories": [
                {"owner": "SomeOrg", "repo": "SomeRepo"}
            ]
        }   
    ]
}

Then install it globally for usage. This same command can be used to update it later as well.

yarn install -g https://github.com/NiXXeD/heimdallr

Then use it!

heimdallr

Tech Used

• NodeJS JavaScript runtime built on Chrome's V8 JavaScript engine.
• inquirer A collection of common interactive command line user interfaces.
• chalk Terminal string styling done right
• moment A JavaScript date library for parsing, validating, manipulating, and formatting dates.
• octokit GitHub REST API client for JavaScript