github-tui

A TUI interface to GitHub.

[!WARNING] github-tui is in pre-alpha stage of development! Expect missing features, surprising behaviour, horrible bugs and breaking changes.

Completion: Done 42%/100% 🌕🌕🌕🌕🌘🌑🌑🌑🌑🌑

[!IMPORTANT] DISCLAIMER: github-tui is developed and maintained in free time voluntarily. The development may continue for decades or may stop tomorrow. You can use GitHub Sponsorship to support the development of this project.

Prerequisites

To use github-tui, you need to have the following installed:

1. OCaml toolchain: to build the project
2. bat version ⩾ 0.19.0
3. Hack Mono Nerd Font

Development

Initialise the project when building for the first time:

opam switch create .

Build the project:

dune build

Run the project:

dune exec bin/main.exe -- owner/repo

Example testing instructions:

dune exec bin/main.exe -- chshersh/github-tui --directory=../github-tui

Install dev dependencies:

opam install utop ocamlformat ocaml-lsp-server