elly

command module
v0.0.36 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 18, 2024 License: MIT Imports: 11 Imported by: 0

README

elly

Github pull requests presented in a prioritized order, via a keyboard driven web GUI & API.

Configured by a Github PAT (personal access token), using the env var GITHUB_PAT. Should be hosted locally.

Screenshot of GUI

Screenshot of GUI, with dark mode

Screenshot of GUI's about screen

flowchart TB
    subgraph elly daemon
    A[./elly] --> B(Request PRs)
    H(systemd) -.->|Runs| A
    B -->|Timer, default 10 min| B
    F[(sqlite)]
    B -->|Persists|F
    A --> C(HTTP server)
    C -->|Reads| F
    C --> D(Server rendered GUI)
    C --> E(API)
    end
    D -.->|Opens in browser| G(Github PR view)
    I(i3blocks) -.-> E

PAT Oauth permissions

A Github personal access token these repository permissions:

  • commit status (read only)
  • contents (read only)
  • metadata (read only)
  • pull requests (read only)

Don't forget to also:

  • allow the token access to "all repositories"
  • adjust the "resource owner" to your personal or your workplace's organisation
  • set a proper expiration date

Installation

go install github.com/chelmertz/elly@latest

will fetch you the latest binary. See contrib/elly.service for a systemd example of managing the service.

Design decisions

See /decisions for ADRs.

Developing

With a .env file containing something like:

export GITHUB_PATH=github_pat_123k135hjhhjtjethwejhtjh5jhj
find . | grep -E 'html|go' | entr -r -s 'source .env && go run .'

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL