- GraalVM Updater
- Native Image
- Polyglot Reference
- Embedding Reference
- Truffle Language Implementation Framework
- JVM Languages Reference
- LLVM Languages Reference
- Python Reference
- R Reference Manual
- Ruby Reference
- Debugging Ruby
- Runtime Configurations
- Using Ruby with GraalVM
- Installing `libssl`
- Installing Make and GCC
- Installing `zlib`
- Migration from JRuby to Ruby
- TruffleRuby Options and Command Line
- Polyglot Programming
- Ruby Managers and Installers
- Standalone Distribution
- Development Tools for Ruby
- Ruby Additional Functionality
- Setting up a UTF-8 Locale
- Reporting Performance Problems
- Optcarrot Example
- WebAssembly Reference
Getting Started #
There are three ways to install TruffleRuby releases and nightly builds:
bin/rubycommand that runs TruffleRuby. We recommend that you use a Ruby manager to use TruffleRuby inside GraalVM.
Via your Ruby manager/installer (RVM, rbenv, chruby, ruby-build, ruby-install). This contains only TruffleRuby, in the native configuration, making it a smaller download. It is meant for users just wanting a Ruby implementation and already using a Ruby manager.
Using the standalone distribution as a simple binary tarball.
We recommend trying TruffleRuby nightly builds which contain the latest fixes and improvements:
RVM: $ rvm install truffleruby-head rbenv: $ rbenv install truffleruby-dev chruby: $ ruby-build truffleruby-dev ~/.rubies/truffleruby-dev
See the Ruby installers documentation for more details.
Testing TruffleRuby in CI is easy: on TravisCI, you can use:
language: ruby rvm: - truffleruby # or truffleruby-head
And on GitHub Actions:
- uses: ruby/setup-ruby@v1 with: ruby-version: truffleruby # or truffleruby-head
See Testing TruffleRuby in CI for more details and other CIs.
You can use
bundle to install Gems as normal.
Please report any issue you might find on GitHub.
TruffleRuby aims to:
- Run idiomatic Ruby code faster
- Run Ruby code in parallel
- Boot Ruby applications in less time
- Execute C extensions in a managed environment
- Provide new tooling such as debuggers and monitoring that work across languages
- All while maintaining very high compatibility with the standard implementation of Ruby
TruffleRuby Runtime Configurations #
There are two main runtime configurations of TruffleRuby: Native and JVM which make different trade-offs.
|Time to start TruffleRuby||about as fast as MRI startup||slower|
|Time to get to peak performance||faster||slower|
|Peak performance (also considering GC)||good||best|
|Java host interoperability||needs reflection configuration||just works|
To find out which runtime configuration is used, run
ruby --version on the command line
or check the value of
TruffleRuby.native? in Ruby code.
Runtime configurations are further detailed in Deploying TruffleRuby.
System Compatibility #
TruffleRuby is actively tested on these systems:
- Oracle Linux 7
- Ubuntu 18.04 LTS
- Ubuntu 16.04 LTS
- Fedora 28
- macOS 10.14 (Mojave)
- macOS 10.15 (Catalina)
- AMD64 (aka
- AArch64 (aka
arm64): Experimental, C extensions do not work yet on AArch64
You may find that TruffleRuby will not work if you severely restrict the
environment, for example by unmounting system filesystems such as
- make and gcc for building C and C++ extensions.
- libssl for the
- zlib for the
Without these dependencies, many libraries including RubyGems will not work. TruffleRuby will try to print a nice error message if a dependency is missing, but this can only be done on a best effort basis.
You may also need to set up a UTF-8 locale.
See the contributor workflow document if you wish to build TruffleRuby from source.
Current Status #
We recommend that people trying TruffleRuby on their gems and applications get in touch with us for help.
TruffleRuby is progressing fast but is currently probably not ready for you to try running your full Rails application on. However it is ready for experimentation and curious end-users to try on their gems and smaller applications, and to send us reports of issues they find.
TruffleRuby has the same version and is released at the same time as GraalVM. There is a release every 3 months, see the release roadmap. There are additional Critical Patch Update releases which are based on regular releases and include extra security fixes.
Migration from MRI #
TruffleRuby should in most cases work as a drop-in replacement for MRI, but you should read about our compatibility.
Migration from JRuby #
For many use cases TruffleRuby should work as a drop-in replacement for JRuby. However, our approach to integration with Java is different to JRuby so you should read our migration guide.
Please report security vulnerabilities via the process outlined at reporting vulnerabilities guide, rather than by something public such as a GitHub issue or a Gitter conversation.
Mailing List #
Announcements about GraalVM, including TruffleRuby, are made on the graal-dev mailing list.
The main authors of TruffleRuby ordered by first contribution are: Chris Seaton, Benoit Daloze, Kevin Menard, Petr Chalupa, Brandon Fish, Duncan MacGregor, Christian Wirth, Rafael França, Alan Wu, Nicolas Laurent, Carol Chen.
TruffleRuby is copyright (c) 2013-2019 Oracle and/or its affiliates, and is made available to you under the terms of any one of the following three licenses:
- Eclipse Public License version 2.0, or
- GNU General Public License version 2, or
- GNU Lesser General Public License version 2.1.