ghcitui: A Terminal User Interface (TUI) for GHCi

[ bsd3, debug, library, program ] [ Propose Tags ]

A terminal user interface for GHCi debug mode.

Features:

  • A source view window, with debug keybindings.

  • Live variable bindings.

  • Live loaded modules.

  • Visible trace history.

  • An GHCi session in the current context.


[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.1.0.0, 0.2.0.0
Change log CHANGELOG.md
Dependencies array (>=0.5 && <0.6), base (>=4.16 && <5), brick (>=2.2 && <2.4), containers (>=0.6.8 && <0.8), errors (>=2.2 && <2.4), extra (>=1.7.14 && <1.8), file-embed (>=0.0.15 && <0.1), ghcid (>=0.8.8 && <0.9), ghcitui, microlens (>=0.4.0.1 && <0.5), microlens-th (>=0.4 && <0.5), optparse-applicative (>=0.17 && <0.19), regex-base (>=0.94.0.2 && <0.95), regex-tdfa (>=1.3.2 && <1.4), string-interpolate (>=0.3.2.1 && <0.4), text (>=2.0 && <2.2), text-zipper (>=0.13 && <0.14), transformers (>=0.6.1.0 && <0.7), utf8-string (>=1.0.2 && <1.1), vector (>=0.10 && <0.14), vty (>=5.38 && <6.3), word-wrap (>=0.5 && <0.6) [details]
License BSD-3-Clause
Copyright Jordan 'Crystal' R AW
Author Jordan 'Crystal' R AW
Maintainer crystal@crystalwobsite.gay
Category Debug
Home page https://github.com/CrystalSplitter/ghcitui
Bug tracker https://github.com/CrystalSplitter/ghcitui/issues
Source repo head: git clone https://github.com/CrystalSplitter/ghcitui
Uploaded by CrystalJRAW at 2024-02-11T22:56:46Z
Distributions
Executables ghcitui
Downloads 71 total (36 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2024-02-11 [all 1 reports]

Readme for ghcitui-0.2.0.0

[back to package description]

GHCiTUI: Interactive terminal interface for the Glasgow Haskell Compiler

          /       ______    __  __    ______    __
        //       /\  ___\  /\ \_\ \  /\  ___\  /\_\
       //     ___\ \ \__ \_\ \  __ \_\ \ \_____\ \ \___
' , _ //      \   \ \_____\ \ \_\ \_\ \ \_____\ \ \_\  \
 / \ // 7      \   \/_____/  \/_/\/_/  \/_____/  \/_/   \
    "   \       \           ______   __  __    __        \
    a   a        \         /\__  _\ /\ \/\ \  /\ \        \
 |_      \        \________\/_/\ \/_\ \ \_\ \_\ \ \________\
   '._    '                   \ \_\  \ \_____\ \ \_\
     (' _ '                    \/_/   \/_____/  \/_/

GitHub Actions Workflow Status Hackage Version

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

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.

$ cd your/cabal/project/root/directory
$ ghcitui

You can specify another directory with the -C <DIR> flag.

$ ghcitui -C some/other/directory

Quitting the TUI

Press <ESC> or q while in the code viewport panel to quit. While not in the code viewport panel, you may press <ESC> to get to the viewport panel.

Contributing

Contributors are welcome! Please see CONTRIBUTING to see how.