https://github.com/i3oris/ic
REPL Interface wrapping Crystal Interpreter (crystal-i).
https://github.com/i3oris/ic
crystal crystal-interpreter crystal-lang crystal-shard interpreter repl
Last synced: 7 months ago
JSON representation
REPL Interface wrapping Crystal Interpreter (crystal-i).
- Host: GitHub
- URL: https://github.com/i3oris/ic
- Owner: I3oris
- License: mit
- Created: 2021-03-27T01:39:22.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-01-07T21:35:42.000Z (about 1 year ago)
- Last Synced: 2025-04-08T12:47:12.943Z (12 months ago)
- Topics: crystal, crystal-interpreter, crystal-lang, crystal-shard, interpreter, repl
- Language: Crystal
- Homepage:
- Size: 4.61 MB
- Stars: 49
- Watchers: 4
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# IC
IC, for **Interactive Crystal**, is an [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) interface for [Crystal Interpreter](https://crystal-lang.org/2021/12/29/crystal-i.html).
It allows to quickly try and test some crystal code, or debug your code thanks to crystal `pry`.
## Features
* [Crystal](https://crystal-lang.org) Interpretation (Indeed!)
* Syntax highlighting
* Multiline input
* Auto formatting
* Auto indentation
* Auto completion (Experimental)
* Code documentation
* History
* Pasting of large expressions
* Debugger
## Warning
The Crystal interpreter is experimental and not yet released, some issue can still occur while interpreting.
## Installation
### Dependencies
You need to install the same dependencies as the crystal compiler, follow the instructions [here](https://github.com/crystal-lang/crystal/wiki/All-required-libraries). If you have already installed crystal from source, you can skip this step.
### Build
```sh
git clone https://github.com/I3oris/ic.git
cd ic
make
# => bin/ic
```
### Optimized Build
```sh
make release
```
> This is a bit long, and require at least 4.5 GB of available RAM.
### Install
Install IC at `/usr/local/`
```
sudo make install
```
### As a Shard
Add this to your `shard.yml` file:
```yaml
development_dependencies:
ic:
github: I3oris/ic
```
And run `shards install`
## Usage
### Interactive mode
```sh
ic
```
### Run file with arguments
```cr
# say_hello.cr
name = ARGV[0]?
puts "Hello #{name}!"
```
```sh
ic say_hello.cr World
```
### Debugger (pry)
On a file use the macro `debugger`:
```cr
# say_hello.cr
debugger # <= will start the debugger at this point
name = ARGV[0]?
puts "Hello #{name}!"
```
Then, just run IC: `ic say_hello.cr World`.
You will see the current position on your code:
```cr
1: # say_hello.cr
2:
3: debugger # <= will start the debugger at this point
=> 4: name = ARGV[0]?
5: puts "Hello #{name}!"
6:
```
On the `pry` prompt you can type:
* `next` : To jump to the next instruction (without entering into functions).
* `step` : To jump to the next instruction (entering into functions if possible).
* `finish` : To jump out of the current function.
* `whereami`: To re-display where the execution is.
* Other : To interpret code while debugging (e.g. the name of a variable).
### Hotkeys
* `alt-enter` (`ctrl-enter` on Windows): Insert a new line character instead of submit edition.
* `ctrl-c`: Keyboard Interruption.
* `ctrl-d`: Delete char or exit (EOF).
* `ctrl-a`/`home`: Move cursor to begin.
* `ctrl-e`/`end`: Move cursor to end.
* `ctrl-k`: Delete after cursor.
* `ctrl-u`: Delete before cursor.
* `alt-backspace`/`ctrl-backspace`: Delete word after
* `alt-d`/`ctrl-delete`: Delete word before.
* `alt-f`/`ctrl-right`: Move word forward.
* `alt-b`/`ctrl-left`: Move word backward.
* `ctrl-up`/`down`: On long multiline input: scroll up/down the view.
* `ctrl-n`/`ctrl-p`: Move cursor up/down.
* `ctrl-b`/`ctrl-f`: Move cursor backward/forward.
Only on debugger (pry):
* `ctrl-up`: `whereami`
* `ctrl-down`: `next`
* `ctrl-left`: `finish`
* `ctrl-right`: `step`
### History
History is saved in `/.ic_history` and is limited to 10_000 entries. It can be changed with environment variables `IC_HISTORY_FILE` and `IC_HISTORY_SIZE`. Use `IC_HISTORY_FILE=""` to disable saving history in a file.
### Commands
You can type the following commands:
* `# clear_history`: Clear history.
* `# reset`: Reset the interpreter (clean all definitions, variables, constants, ...)
## Contributing:
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [I3oris](https://github.com/I3oris) - creator and maintainer