CrystalSplitter/ghcitui
1
1
Fork 0
mirror of https://github.com/CrystalSplitter/ghcitui.git synced 2024-09-11 10:55:29 +03:00
Code Issues Packages Projects Releases Wiki Activity
A Terminal User Interface for the Glasgow Haskell Compiler Interactive Mode
40 Commits 2 Branches 3 Tags 273 KiB
Haskell 99.7%
Shell 0.3%
652c0493b2
Go to file
CrystalSplitter 652c0493b2 Simplify INSTALL.rst
2024-01-15 02:12:47 -08:00
.github/workflows Add basic github haskell CI 2023-10-15 01:21:43 -07:00
app Allow quitting via Esc 2024-01-15 02:12:47 -08:00
assets Some more early development 2023-06-06 22:19:12 -07:00
lib Remove deprecated lib/Tui.hs 2024-01-15 02:12:47 -08:00
test Update UtilSpec module name 2023-10-15 01:21:43 -07:00
.gitignore Add .gitignore 2023-06-03 19:36:39 -07:00
cabal.project Add cabal.project 2023-10-14 21:32:14 -07:00
CHANGELOG.md Some more early development 2023-06-06 22:19:12 -07:00
CONTRIBUTING.md Update CONTRIBUTING.md with full CoC 2023-10-08 18:25:49 -07:00
fourmolu.yaml Add fourmolu.yaml 2023-06-03 19:36:09 -07:00
fswatch_build.sh The interpreter commit 2023-07-30 16:02:36 -07:00
ghcitui.cabal Wider range for base versions 2023-10-15 01:21:43 -07:00
INSTALL.rst Simplify INSTALL.rst 2024-01-15 02:12:47 -08:00
LICENSE Newline at the end of the LICENSE 2023-10-08 00:38:41 -07:00
README.md Update README.md with more instructions 2023-10-16 00:36:32 -07:00

README.md

GHCiTUI: Interactive terminal interface for the Glasgow Haskell Compiler

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

This is an experimental front-end terminal interface for ghci. It provides a source viewer, keybindings, an interactive interpreter, and a local context viewer.

Installation

As this project is experimental, currently installing from source is the only option.

See INSTALLATION.rst for details.

Basic Usage

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.md to see how.