Peer - A pull request visualizer for github (and others)

Peer helps you track down and visualize your PRs across organizations and accounts (and eventually™ across git providers).

Peer is meant to be easy to use, cross platform and helpful!

Statuses

Pull request statuses are all emoji to save space (and because why not?) The default format provider gives the following mapping:

    Unknown =>          ❔
    Conflict =>         ⚔️,
    Draft =>            📃,
    ActionsPending =>   ⏳,
    ActionsQueued =>    💤,
    Stale =>            🍞,
    FailedChecks =>     🔥,
    AwaitingReview =>   🚩,
    FixesRequested =>   ❌,
    ReadyToMerge =>     ✔️,
    Merged =>           🎊 (You shouldn't really see this one)

Installing peer

Peer is available as a standalone windows executable on scoop, a portable exe in our github releases and also as a dotnet tool (currently requires net6 rc2)

via scoop:

scoop bucket add wimm https://github.com/wareismymind/wareismy-scoop
scoop install peer

via dotnet:

dotnet tool install --global peer

via github releases

for windows:
- x64
  - https://github.com/wareismymind/peer/releases/latest/download/peer_win-x64.exe
- arm64
  - https://github.com/wareismymind/peer/releases/latest/download/peer_win-arm64

for osx:
- x64
  - https://github.com/wareismymind/peer/releases/latest/download/peer_osx-x64
- arm64
  - https://github.com/wareismymind/peer/releases/latest/download/peer_osx-arm64

for linux:
- x64
  - https://github.com/wareismymind/peer/releases/latest/download/peer_linux-x64
- arm64
  - https://github.com/wareismymind/peer/releases/latest/download/peer_linux-arm64

Dependencies

Peer requires a few things to run properly on different platforms. This list may not be exhaustive but we're working on making sure.

• linux
  • ca-certificates (https communication)
  • openssl (https communication)
  • utf8 supporting terminal
• windows
  • utf8 terminal (Windows Terminal, the pwsh/powershell terminal for ex)
  • Font with emoji support (Nerdfonts are a good bet and are available on scoop)

Platform/Runtime support

• Tier 1 (We're definitely gonna fix these right away when they're busted because we have hardware/automation to do it)
  • All x64 targets
    • windows
    • linux
    • mac
• Tier 2 (Things we have hardware to test or can test automagically)
  • linux arm64
• Tier 3 (We don't have the hardware to test but we'll do our best!)
  • win-arm64
  • osx-arm64

Environment variables

Peer configuration can be specified in the config file or in environment variables. Environment variables take precedence over the config file. When using environment variables, the levels of nesting are represented using double underscores. For example, the environment variable PEER__WATCHINTERVALSECONDS would override the Peer.WatchInvervalSeconds value in the config file.

Setting a config variable in sh-like shells

export PEER__WATCHINTERVALSECONDS=30

Setting a config variable in pwsh/powershell

$env:PEER__WATCHINTERVALSECONDS = 20

Some specially named variables are respected during the config load and editor opening commands:

• PEER_CONFIGPATH if this is set then peer will look for its config there instead of the default locations
• EDITOR peer will invoke your editor for commands that require it such as config edit. If this variable isn't set peer will open it using the default handler on your operating system