Skip to content

the-chaos-collective/appletini

Repository files navigation

Appletini

Build Status

Appletini is a GitHub client that runs in your systray.

It allows you to keep track of Pull Requests assigned to you and others you may be interested in.

Compatibility

Appletini is multi-platform, supporting Windows, Mac OS, and Linux*

* tested with Gnome on Ubuntu 22.04 (both Wayland & XOrg)

Running

Download a pre-built binary

You may find pre-built binaries for your operating system here.

Configuration

A config.json file will be generated next to the binary. You may use it to configure appletini.

Create an env variable on your system holding your personal access token (I used a classic one with repo, user and projects permission). You may use any name for it, just make sure to use the same name in the config file.

  • token: NAME of the env variable that holds your github personal access token
  • trackers: your trackers (different filters to find PRs you're interested in)
    • personal: true if you'd like to see the "My Pull Requests" sub-menu, false otherwise
    • byLabel:
      • title: string that will appear on the systray to hold all the PRs related to that label
      • label: label you want to filter by
      • repo: repo where you want to filter by label
      • owner: repo owner
    • byRepo:
      • title: string that will appear on the systray to hold your PRs
      • repo: repo you want to see all the PRs of
      • owner: repo owner
    • byAuthor:
      • title: string that will appear on the systray to hold the PRs by these authors
      • authors: list of authors you want to filter by
      • repo: repo you want to see the PRs of
      • owner: repo owner
  • darkMode: changes the icon color

Development

Pre-requisites

  • go
  • gcc

Ubuntu: sudo apt install gcc golang

Mac: brew install gcc golang

Windows: https://go.dev/doc/install

Building

We use Taskfile. You may run the following command to build & run the software:

task run