:: => run a shell command, example ::ls

You can use arrow keys to cycle through commands history

Keybindings

ctrl-l clear screen

ctrl-c clear line

ctrl-d exit if buffer is empty

ctrl-z [unix only] send IRust to the background

ctrl-r search history, hitting ctrl-r again continues searching the history backward, hitting ctrl-s searches the history forward

ctrl-left/right jump through words

HOME/END go to line start / line end

Tab/ShiftTab cycle through auto-completion suggestions (requires racer)

Alt-Enter add line break

ctrl-e force evaluation

Cli commands

--help prints help message

--reset-config reset IRust configuration to default

Configuration

IRust config file is located in:

Linux: /home/$USER/.config/irust/config

Win: C:\Users\$USER\AppData\Roaming/irust/config

Mac: /Users/$USER/Library/Preferences/irust/config

default config: ``` # history addirustcmdtohistory = true addshellcmdtohistory = false

# colors okcolor = "Blue" evalcolor = "White" irustcolor = "DarkBlue" irustwarncolor = "Cyan" outcolor = "Red" shellcolor = "DarkYellow" errcolor = "DarkRed" inputcolor = "Green" insertcolor = "White" welcomemsg = "" welcomecolor = "DarkBlue"

# racer racerinlinesuggestioncolor = "Cyan" racersuggestionstablecolor = "Green" racerselectedsuggestioncolor = "DarkRed" racermaxsuggestions = 5 enableracer = true

# other firstirustrun = false toolchain = "stable" checkstatements = true autoinsert_semicolon = true

// use last output by replacing the specified marker replacemarker = "$out" replaceoutputwithmarker = false

# modify input prmopt inputprompt = "In: " outputprompt = "Out: "

# activate scripting feature activate_scripting = false ```

Theme

Since release 0.8.9 IRust can now parse a theme file located on $config_dir/irust/theme and use it for the highlighting colors.

Colors can be specified as names ("red") or as hex representation ("#ff12ab").

Default theme file:

``` keyword = "magenta" keyword2 = "darkred" function = "blue" type = "cyan" number = "darkyellow" symbol = "red" macro = "darkyellow" stringliteral = "yellow" character = "green" lifetime = "darkmagenta" comment = "darkgrey" const = "dark_green" x = "white"

```

Scripts

Since release 1.7.0 IRust has a new script mechanism codename script2, the old method is still available but deprecated for now see below if you still want to use it.

The main advantages are:

• No unsafe, scripts should not be able to break IRust (not 100%)
• Hot reloading! recompiling a script will immediatly take effect on IRust without restarting

To activate this feature, set activate_scripting2 to true in the configuration file. (it will take precedence over script1 if its set to true)

Now IRust will look in $config/irust/script2 for executables.

It will launch them when required and comminucate via stdin/stdout (with bincode as a relay).

The executables need to have the following properties:

| Name | Input | Output | What it should do | ---------------- | --------------------------- | ------- | ------------------------------------------------- | inputprompt | irustapi::GlobalVariables | String | return the input prompt value as a string | outputprompt | irustapi::GlobalVariables | String | return the output prompt value as a string | whilecompiling | irustapi::GlobalVariables | () | do arbitrary things while IRust is compiling an expression (print some waiting animation for example)

All scripts should add bincode and irust_api as dependecy

For more concrete example see scripts_examples directory

Old method

Since release 1.5.0 IRust introduced scripting feature.

To activate it, set activate_scripting to true in the configuration file.

Now IRust will create a cargo project named script located at $config/irust/script

This project has a default template, that showcases the available features.

Currently Supported functions (see example): rust pub extern "C" fn input_prompt(global_varibales: &GlobalVariables) -> *mut c_char rust pub extern "C" fn output_prompt(global_varibales: &GlobalVariables) -> *mut c_char

Important points: - Scripting is currently unsafe, using it incorrectly will cause IRust to crash or segfault - Scripts have a higher precedence then options (for example prompt functions will override the prompt set in the configuration)

Template/Example: ```rust /// This script prints an input/output prompt with the number of the /// evaluation prefixed to it use std::{ffi::CString, os::raw::c_char, path::PathBuf};

// the signature must be this pub struct GlobalVariables { // Current directory that IRust is in currentworkingdir: PathBuf, // Previous directory that IRust was in, this current directory can change if the user uses the :cd command _previousworkingdir: PathBuf, // Last path to a rust file loaded with :load command _lastloadedcodepath: Option, /// Last successful printed output lastoutput: Option, /// A variable that increases with each input/output cycle operation_number: usize, }

[no_mangle]

// the signature must be this pub extern "C" fn inputprompt(globalvaribales: &GlobalVariables) -> *mut cchar { // Default script CString::new(format!("In [{}]: ", globalvaribales.operationnumber)) .unwrap() .intoraw() }

[no_mangle]

// the signature must be this pub extern "C" fn outputprompt(globalvaribales: &GlobalVariables) -> *mut cchar { // Default script CString::new(format!("Out[{}]: ", globalvaribales.operationnumber)) .unwrap() .intoraw() } ```

Book

The IRust Book is intended to document a couple of tips and tricks https://sigmasd.github.io/irust_book

Releases

Automatic releases by github actions are uploaded here https://github.com/sigmaSd/irust/releases

Building

cargo b --release

FAQ

1- Why is autocompletion not working

-> you need racer installed and configured correctly
    cargo +nightly install racer
    rustup component add rust-src

2- Racer fails to build

You can try rustup update --force https://github.com/racer-rust/racer/issues/1141

3- I want to hack on irust but dbg! overlaps with the output!!

Personaly I do this: - Run 2 terminals side by side - run tty in the first which should output something like /dev/pts/4 - run cargo r 2>/dev/pts4 in the second

Now the dbg! statements are printed on the second terminal and the output in the first terminal is not messed up.

Changelog