Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Lightweight Ruby
C Ruby Yacc C++ Batchfile Shell
Branch: master

Merge pull request #2984 from sagmor/yard

Simpler documentation
latest commit 02a6d866ba
@matz matz authored
Failed to load latest commit information.
benchmark Remove benchmarks not in mruby
bin add mruby sources
doc/guides Move guides location
examples change BIN_PATH for new gc in Arduino IDE >= 1.5.7
include Fix `mrb_obj_respond_to`
lib/mruby Change to to make Ruby 1.9 Happy
mrbgems print unicode on windows console
mrblib remove a comment that no longer be true; 2cb6c27
src Array#index to take block; fix #2968 close #2970
tasks Add optional params to toolchain configuration
test clarify asserts to UTF-8 test suites; ref #2971
.gitignore Move guides location
.travis.yml travis-CI migration
.yardopts Move guides location
AUTHORS Update AUTHORS Fix typos in documentation and error messages [skip ci]
ChangeLog add document
LEGAL Change mruby-random License to MIT
MITL Update Coopyright Information to year 2015
Makefile remove trailing spaces
NEWS add document Get rid of weird whitespace
Rakefile Customize installation directory using INSTALL_DIR environment variable
TODO Remove things that look done.
build_config.rb Revert 7b5f8b0 except removing trailing spaces
minirake Correctly handle relative paths
mruby-source.gemspec Switch gem API to constants only
travis_config.rb Add build_mrbtest after config block is evaluated

Build Status

What is mruby

mruby is the lightweight implementation of the Ruby language complying to (part of) the ISO standard. Its syntax is Ruby 1.9 compatible.

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.

How to get mruby

The stable version 1.1.0 of mruby can be downloaded via the following URL:

The latest development version of mruby can be downloaded via the following URL:

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

$ git clone

mruby home-page

The URL of the mruby home-page is:

Mailing list

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

How to compile and install (mruby and gems)

See the doc/compile/ file.

Running Tests

To run the tests, execute the following from the project's root directory.

$ make test


$ ruby ./minirake test

How to customize mruby (mrbgems)

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 doc/mrbgems/ For example code of how to use mrbgems look into the folder examples/mrbgems/.


mruby is released under the MIT License.

Note for 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.

How to Contribute

See the contribution guidelines, and then send a pull request to We consider you have granted non-exclusive right to your contributed code under MIT license. If you want to be named as one of mruby developers, please include an update to the AUTHORS file in your pull request.

Something went wrong with that request. Please try again.