An open API service indexing awesome lists of open source software.

https://github.com/gnebbia/vimi

A vimscript interpreter for GNU/Linux, MacOS and *BSDs
https://github.com/gnebbia/vimi

interpreted-language interpreter scripting-language vim vimi vimscript vimscript-library

Last synced: 2 months ago
JSON representation

A vimscript interpreter for GNU/Linux, MacOS and *BSDs

Awesome Lists containing this project

README

        

# vimi

This project is an attempt at creating a simple vimscript interpreter.
Vimi is able to take as input a vimscript and execute it, and hence
it makes vim more similar to any other full-fledged programming
language.

## Installation

In order to install vimi we can simply clone this repo
and execute the install.sh script by doing:

```sh
git clone https://github.com/gnebbia/vimi
```

and then:

```sh
cd vimi/
bash install.sh
```

## Executing a script

Like other programming languages, we can execute our vim script
by calling the vimscript interpreter like this:

```sh
vimi myscript.vim
```

As a demo example, let's create a simple script which we will
call example.vim with the following content:

```vim
"take user input
let ciao = Input("Type something: ")

"print to screen what user inserted
echo "You inserted: " . ciao

"print to screen arguments passed"
let passed_args = Argv()
echo(passed_args)
```

vimi will execute the script by executing:
```sh
vimi example.vim --arg1 value1 --arg2 value2 -v
```

## License

The vimi interpreter is under GPLv3 license. Please see LICENSE file for more
details.