CrystalSplitter/ghcitui
1
1
Fork 0
mirror of https://github.com/CrystalSplitter/ghcitui.git synced 2024-11-22 06:32:37 +03:00
Code Issues Packages Projects Releases Wiki Activity
A Terminal User Interface for the Glasgow Haskell Compiler Interactive Mode
97 Commits 2 Branches 5 Tags 490 KiB
Haskell 99.7%
Shell 0.3%
35efe6172b
Go to file
CrystalSplitter 35efe6172b Update GitHub actions 
This moves the actions to Node 20, and also runs actions against
`develop` branch.
2024-02-10 21:00:43 -08:00
.github Update GitHub actions 2024-02-10 21:00:43 -08:00
app Reorganise modules to create the Ghcitui.Brick module 2024-01-19 01:46:31 -08:00
assets Some more early development 2023-06-06 22:19:12 -07:00
docs/assets Add Splash screenshot to README.md 2024-01-17 01:01:51 -08:00
gen Mention autocomplete in the MANUAL 2024-02-10 20:17:42 -08:00
lib Add better documentation for AppInterpState 2024-02-10 20:17:42 -08:00
test Add submodule Ghcitui for all library components 2024-01-15 02:12:47 -08:00
.gitattributes Use git lfs to store screenshots 2024-01-17 01:01:51 -08: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 Update docs 2024-01-21 17:59:12 -08:00
CONTRIBUTING.md Update docs 2024-01-21 17:59:12 -08:00
fourmolu.yaml Add fourmolu.yaml 2023-06-03 19:36:09 -07:00
fswatch_build.sh Run tests with the fswatch_build.sh 2024-01-15 02:12:47 -08:00
ghcitui.cabal Implement tab completion 2024-02-10 20:17:42 -08:00
INSTALL.rst Update README and INSTALL for Hackage 2024-01-21 14:59:41 -08:00
LICENSE Newline at the end of the LICENSE 2023-10-08 00:38:41 -07:00
MANUAL.rst Mention autocomplete in the MANUAL 2024-02-10 20:17:42 -08:00
README.md Update docs 2024-01-21 17:59:12 -08:00
regenerate_help.sh Fix missing keybindings in MANUAL.rst 2024-01-15 13:04:18 -08:00

README.md

GHCiTUI: Interactive terminal interface for the Glasgow Haskell Compiler

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

GitHub Actions Workflow Status

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.