Skip to main content

Using the Ruby Host SDK

Check your installation

Please be sure you've installed Extism before continuing with this guide.

1. Install the Ruby gem​

The gem is hosted on RubyGems. Put the extism gem in your Gemfile:

gem "extism", "~> 0.3.0"

Or install with gem install if you are not using bundler:

gem install extism

2. Require the library and use the APIs​

Count Vowels Plugin

code.wasm in this example is our example plugin that counts vowels. If you want to run this, download it first and set the path:

curl https://raw.githubusercontent.com/extism/extism/main/wasm/code.wasm > code.wasm
app.rb
require 'extism'
require 'json'

# a Context provides a scope for plugins to be managed within. creating multiple contexts
# is expected and groups plugins based on source/tenant/lifetime etc.
# We recommend you use `Extism.with_context` unless you need to keep your context around.
# If you do you can create a context with `Extism::Context#new`, example: `ctx = Extism::Context.new`
Extism.with_context do |ctx| 
  manifest = {
    :wasm => [{:path => "code.wasm"}]
  }


  # NOTE: if you encounter an error such as: 
  # "Unable to load plugin: unknown import: wasi_snapshot_preview1::fd_write has not been defined"
  # pass `true` after `manifest` in the following function to provide WASI imports to your plugin.
  plugin = ctx.plugin(manifest)
  res = JSON.parse(plugin.call("count_vowels", ARGV[0] || "this is a test"))
  
  puts res['count']
end

Need help?​

If you've encountered a bug or think something is missing, please open an issue on the Extism GitHub repository.

There is an active community on Discord where the project maintainers and users can help you. Come hang out!