mruby is the lightweight implementation of the Ruby language complying to (part of) the ISO standard with more recent features provided by Ruby 3.x. Also, its syntax is Ruby 3.x compatible except for pattern matching.

mruby can be linked and embedded within your application. We provide the interpreter program "mruby", and the interactive mruby shell "mirb" as examples. You can also compile Ruby programs into compiled byte code using the mruby compiler "mrbc". All those tools reside in the "bin" directory. "mrbc" is also able to generate compiled byte code in a C source file, see the "mrbtest" program under the "test" directory for an example.

This achievement was sponsored by the Regional Innovation Creation R&D Programs of the Ministry of Economy, Trade and Industry of Japan.

The stable version 3.2.0 of mruby can be downloaded via the following URL: https://github.com/mruby/mruby/archive/3.2.0.zip

The latest development version of mruby can be downloaded via the following URL: https://github.com/mruby/mruby/zipball/master

The trunk of the mruby source tree can be checked out with the following command:

$ git clone https://github.com/mruby/mruby.git

You can also install and compile mruby using ruby-install, ruby-build or rvm.

The URL of the mruby home-page is: https://mruby.org.

We don't have a mailing list, but you can use GitHub issues.

For the simplest case, type

rake all test

See the compile.md file for the detail.

There are two sets of documentation in mruby: the mruby API (generated by yard) and C API (Doxygen and Graphviz)

To build both of them, simply go

rake doc

You can also view them in your browser

rake view_api
rake view_capi

mruby contains a package manager called mrbgems. To create extensions in C and/or Ruby you should create a GEM. For a documentation of how to use mrbgems consult the file mrbgems.md. For example code of how to use mrbgems look into the folder examples/mrbgems/.

mruby is released under the MIT License.

mruby has chosen a MIT License due to its permissive license allowing developers to target various environments such as embedded systems. However, the license requires the display of the copyright notice and license information in manuals for instance. Doing so for big projects can be complicated or troublesome. This is why mruby has decided to display "mruby developers" as the copyright name to make it simple conventionally. In the future, mruby might ask you to distribute your new code (that you will commit,) under the MIT License as a member of "mruby developers" but contributors will keep their copyright. (We did not intend for contributors to transfer or waive their copyrights, actual copyright holder name (contributors) will be listed in the AUTHORS file.)

Please ask us if you want to distribute your code under another license.

See the contribution guidelines, and then send a pull request to https://github.com/mruby/mruby. We consider you have granted non-exclusive right to your contributed code under MIT license.