Download

You can download one of the following pre-built min binaries:

Tip

A printable, self-contained guide containing more or less the same content of this web site can be downloaded from here.

Building from Source

Alternatively, you can build min from source as follows:

  1. Download and install nim.
  2. Download and build Nifty, and put the nifty executable somewhere in your $PATH.
  3. Clone the min repository.
  4. Navigate to the min repository local folder.
  5. Run nifty install to download min’s dependencies.
  6. Run nim c -d:release min.nim.

Additional build options

-d:ssl

If the -d:ssl flag is specified when compiling, min will be built with SSL support, so it will be possible to perform HTTPS requests with the http Module. This means that the resulting min executable will no longer be self-contained and it will require the OpenSSL dynamic library to be available on your system.

-d:lite

If the d:lite flag is specified, an even more minimal executable file will be generated, however the following functionalities will not be available:

Running then min Shell

To start min shell, run min -i. You will be presented with a prompt displaying the path to the current directory:

[/Users/h3rald/test]$

You can type min code and press ENTER to evaluate it immediately:

[/Users/h3rald/test]$ 2 2 + {1} -> 4 [/Users/h3rald/test]$

The result of each operation will be placed on top of the stack, and it will be available to subsequent operation

[/Users/h3rald/test]$ dup * {1} -> 16 [/Users/h3rald/test]$

To exit min shell, press CTRL+C or type exit and press ENTER.

Executing a min Program

To execute a min script, you can:

min also supports running programs from standard input, so the following command can also be used (on Unix-like system) to run a program saved in myfile.min:

$ cat myfile.min | min

Syntax Highlighting