2023-06-07 08:19:12 +03:00
|
|
|
# GHCiTUI: Interactive terminal interface for the Glasgow Haskell Compiler
|
|
|
|
|
2023-10-16 10:33:15 +03:00
|
|
|
```
|
|
|
|
/ ______ __ __ ______ __
|
|
|
|
// /\ ___\ /\ \_\ \ /\ ___\ /\_\
|
|
|
|
// ___\ \ \__ \_\ \ __ \_\ \ \_____\ \ \___
|
|
|
|
' , _ // \ \ \_____\ \ \_\ \_\ \ \_____\ \ \_\ \
|
|
|
|
/ \ // 7 \ \/_____/ \/_/\/_/ \/_____/ \/_/ \
|
|
|
|
" \ \ ______ __ __ __ \
|
|
|
|
a a \ /\__ _\ /\ \/\ \ /\ \ \
|
|
|
|
|_ \ \________\/_/\ \/_\ \ \_\ \_\ \ \________\
|
|
|
|
'._ ' \ \_\ \ \_____\ \ \_\
|
|
|
|
(' _ ' \/_/ \/_____/ \/_/
|
|
|
|
```
|
|
|
|
|
2023-10-15 08:05:11 +03:00
|
|
|
This is an experimental front-end terminal interface for
|
2023-06-07 08:19:12 +03:00
|
|
|
`ghci`. It provides a source viewer, keybindings, an interactive
|
|
|
|
interpreter, and a local context viewer.
|
2023-10-15 08:05:11 +03:00
|
|
|
|
2024-01-17 09:51:09 +03:00
|
|
|
![Splash Image For GHCiTUI](docs/assets/20240116_splash.png)
|
|
|
|
|
2023-10-15 08:05:11 +03:00
|
|
|
## Installation
|
|
|
|
|
|
|
|
As this project is experimental, currently installing from
|
|
|
|
source is the only option.
|
|
|
|
|
|
|
|
See [INSTALLATION.rst](./INSTALL.rst) for details.
|
|
|
|
|
2023-10-16 10:33:15 +03:00
|
|
|
## Basic Usage
|
|
|
|
|
2023-12-10 05:11:02 +03:00
|
|
|
For detailed usage, please see the [manual](./MANUAL.rst).
|
|
|
|
|
2023-10-16 10:33:15 +03:00
|
|
|
### 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 <DIR>` flag.
|
|
|
|
|
|
|
|
```bash
|
|
|
|
$ 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.
|
|
|
|
|
2023-10-15 08:05:11 +03:00
|
|
|
## Contributing
|
|
|
|
|
|
|
|
Contributors are welcome! Please see [CONTRIBUTING.md](./CONTRIBUTING.md)
|
|
|
|
to see how.
|