Guides

Guides

Task-based walkthroughs, from a first chat to writing your own provider.

Each guide is one task with a result you can check at the end. Start with your first session if you have never run elelem. The rest stand alone: run a model offline, write a tool or a provider, connect MCP servers and agent skills, script elelem from the shell, or measure models against each other. Every command and file path comes from the source of the gems involved, and each guide says which ones it uses.

  1. Your first session Install elelem with the default tools and Ollama, chat with a local model, and ask a one-shot question. Beginner10 minutes, plus the model download
  2. Run elelem fully offline Run a GGUF model inside the elelem process with elelem-llama, with GPU offload and a context size you choose. Intermediate30 minutes, most of it compiling and downloading
  3. Write a tool plugin Add a tool the model can call, in one Ruby file, then package it as a gem. Beginner15 minutes
  4. Write a provider plugin Connect elelem to a new model API by implementing one method, fetch, that streams events back to the agent. Advanced45 minutes
  5. Connect MCP servers Give the agent the tools of any MCP server, local over stdio or remote over HTTP with OAuth, using elelem-mcp. Intermediate15 minutes
  6. Use agent skills Write a SKILL.md file, let the model load it when it needs it, and install skills from a remote index. Beginner10 minutes
  7. Use elelem in shell pipelines Pipe text into elelem ask, feed it files with elelem files, and use the reply in scripts and git workflows. Beginner10 minutes
  8. Compare models with elelem-evals Run the same coding tasks against different providers and models, and write your own cases to test what matters to you. Advanced30 minutes, plus model run time