https://github.com/chshersh/github-tui

🌒 A TUI for GitHub
https://github.com/chshersh/github-tui

git github ocaml tui

Last synced: 8 days ago
JSON representation

🌒 A TUI for GitHub

• Host: GitHub
• URL: https://github.com/chshersh/github-tui
• Owner: chshersh
• License: mpl-2.0
• Created: 2023-12-26T12:42:15.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-06-28T07:37:44.000Z (4 months ago)
• Last Synced: 2024-08-03T15:08:11.587Z (3 months ago)
• Topics: git, github, ocaml, tui
• Language: OCaml
• Homepage:
• Size: 8.26 MB
• Stars: 46
• Watchers: 2
• Forks: 3
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# github-tui

A TUI interface to GitHub.



  



> [!WARNING]

> `github-tui` is in _pre-alpha_ stage of development!

> Expect missing features, surprising behaviour and horrible bugs.

>

> **Completion**: Done 26%/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](https://github.com/sponsors/chshersh) 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

1. `bat` version ⩾ 0.19.0

1. [Hack Mono Nerd Font](https://www.nerdfonts.com/)

## 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

```

Install dev dependencies:

```

opam install utop ocamlformat ocaml-lsp-server

```