https://github.com/CrystalSplitter/ghcitui

A Terminal User Interface for the Glasgow Haskell Compiler Interactive Mode
https://github.com/CrystalSplitter/ghcitui

Last synced: 2 months ago
JSON representation

A Terminal User Interface for the Glasgow Haskell Compiler Interactive Mode

• Host: GitHub
• URL: https://github.com/CrystalSplitter/ghcitui
• Owner: CrystalSplitter
• License: bsd-3-clause
• Created: 2023-07-16T20:07:28.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-29T00:43:39.000Z (6 months ago)
• Last Synced: 2024-07-29T01:36:02.500Z (6 months ago)
• Language: Haskell
• Size: 184 KB
• Stars: 55
• Watchers: 6
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome - CrystalSplitter/ghcitui - 11 star:0.1k fork:0.0k A Terminal User Interface for the Glasgow Haskell Compiler Interactive Mode (Haskell)

README

        
# GHCiTUI: Interactive terminal interface for the Glasgow Haskell Compiler

```

          /       ______    __  __    ______    __

        //       /\  ___\  /\ \_\ \  /\  ___\  /\_\

       //     ___\ \ \__ \_\ \  __ \_\ \ \_____\ \ \___

' , _ //      \   \ \_____\ \ \_\ \_\ \ \_____\ \ \_\  \

 / \ // 7      \   \/_____/  \/_/\/_/  \/_____/  \/_/   \

    "   \       \           ______   __  __    __        \

    a   a        \         /\__  _\ /\ \/\ \  /\ \        \

 |_      \        \________\/_/\ \/_\ \ \_\ \_\ \ \________\

   '._    '                   \ \_\  \ \_____\ \ \_\

     (' _ '                    \/_/   \/_____/  \/_/

```

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/CrystalSplitter/ghcitui/haskell.yaml) ![Hackage Version](https://img.shields.io/hackage/v/ghcitui)

This is an experimental front-end terminal interface for

`ghci`. It provides a source viewer, keybindings, an interactive

interpreter, and a local context viewer.

![Splash Image For GHCiTUI](https://media.githubusercontent.com/media/CrystalSplitter/ghcitui/main/docs/assets/20240116_splash.png)

## Installation

You can install this project from Hackage using `cabal` or from source. See [INSTALLATION] for details.

## Basic Usage

For full usage, please see the [manual].

### Starting the TUI

GHCiTUI runs a repl in the current directory by default.

```bash

$ cd your/cabal/project/root/directory

$ ghcitui

```

You can specify another directory with the `-C ` flag.

```bash

$ ghcitui -C some/other/directory

```

### Quitting the TUI

Press `` or `q` while in the code viewport panel to quit. While not in the

code viewport panel, you may press `` to get to the viewport panel.

## Contributing

Contributors are welcome! Please see [CONTRIBUTING] to see how.

[INSTALLATION]: https://github.com/CrystalSplitter/ghcitui/blob/main/INSTALL.rst

[manual]: https://github.com/CrystalSplitter/ghcitui/blob/main/MANUAL.rst

[CONTRIBUTING]: https://github.com/CrystalSplitter/ghcitui/blob/main/CONTRIBUTING.md