ruby_llm

(★ 4,309)

One delightful Ruby framework for every major AI provider. Build AI agents, chatbots, RAG apps, and multimodal workflows in beautiful, expressive code.

File Explorer

ZIP Download

- - bug_report.yml
  - config.yml
  - feature_request.yml
- - _gitleaks.yml
  - _lint.yml
  - _test-matrix.yml
  - docs.yml
  - main.yml
  - pr.yml
  - release.yml
- FUNDING.yml
- pull_request_template.md
- console
- gitleaks-staged
- rspec-queue
- setup
- test
- - agentic-workflows.md
  - agents.md
  - async.md
  - batches.md
  - durable-agents.md
  - error-handling.md
  - instrumentation.md
  - memory.md
  - rag.md
  - rails-advanced-config.md
  - rails-generators.md
  - rails-persistence.md
  - rails-streaming.md
  - rails.md
- - attachments.md
  - audio-transcription.md
  - chat-callbacks.md
  - chat-request-control.md
  - chat.md
  - citations.md
  - cost-and-usage-tracking.md
  - embeddings.md
  - files.md
  - image-generation.md
  - moderation.md
  - ocr.md
  - prompt-caching.md
  - prompt-rendering.md
  - rerank.md
  - server-tools.md
  - streaming.md
  - structured-output.md
  - text-to-speech.md
  - thinking.md
  - tool-execution.md
  - tool-parameters.md
  - tools.md
  - video-generation.md
- - company_logos.yml
  - company_logos_featured.yml
  - navigation.yml
  - sidebar.yml
  - social_links.yml
  - versions.yml
- - configuration-connection.md
  - configuration-providers.md
  - configuration.md
  - getting-started.md
  - overview.md
- - home.html
  - version_select.html
- - rouge_rubyllm_themes.rb
  - sass_deprecation_options.rb
- - api-reference.md
  - available-models.md
  - custom-endpoints.md
  - custom-providers.md
  - ecosystem.md
  - model-resolution.md
  - models.md
  - upgrading.md
- - build-api.sh
  - build-versions.sh
  - export-api-markdown.rb
  - postprocess_api_seo.rb
  - prepare_one_x_docs.rb
  - serve.sh
- .gitignore
- _config.yml
- about.md
- Gemfile
- index.md
- ruby_llm
- - config
- rails_7.1.gemfile
- rails_7.2.gemfile
- rails_8.0.gemfile
- rails_8.1.gemfile
- - agent.rb
  - aliases.json
  - aliases.rb
  - attachment.rb
  - batch.rb
  - cached_content.rb
  - chat.rb
  - chunk.rb
  - citation.rb
  - configuration.rb
  - connection.rb
  - context.rb
  - cost.rb
  - deprecator.rb
  - embedding.rb
  - embedding_request.rb
  - error.rb
  - error_middleware.rb
  - fallback.rb
  - image.rb
  - inspectable.rb
  - instrumentation.rb
  - message.rb
  - mime_type.rb
  - model.rb
  - model_registry.rb
  - model_schema.rb
  - models.json
  - models.rb
  - moderation.rb
  - ocr.rb
  - prompt.rb
  - protocol.rb
  - provider.rb
  - provider_generator_cli.rb
  - provider_scaffold.rb
  - railtie.rb
  - rerank.rb
  - search_results.rb
  - server_tool_call.rb
  - server_tools.rb
  - speech.rb
  - stream_accumulator.rb
  - streaming.rb
  - thinking.rb
  - tokens.rb
  - tool.rb
  - tool_call.rb
  - tool_concurrency.rb
  - transcription.rb
  - transcription_chunk.rb
  - uploaded_file.rb
  - usage.rb
  - usage_middleware.rb
  - utils.rb
  - version.rb
  - video.rb
  - video_job.rb
  - workflow.rb
- - ruby_llm.rake
- ruby_llm.rb
- generate-provider
- - .gitignore
  - config.ru
  - Gemfile
  - Rakefile
  - README.md
- - facts.txt
  - ruby.mp3
  - ruby.mp4
  - ruby.png
  - ruby.txt
  - ruby.wav
  - ruby.xml
  - sample.docx
  - sample.pdf
  - sample.xlsx
- - agent_dsl_spec.rb
  - agent_rails_spec.rb
  - agent_rescue_from_spec.rb
  - agent_spec.rb
  - attachment_spec.rb
  - batch_helpers_spec.rb
  - batch_spec.rb
  - cached_content_spec.rb
  - chat_assume_model_exists_spec.rb
  - chat_before_request_spec.rb
  - chat_cache_until_here_spec.rb
  - chat_callbacks_spec.rb
  - chat_citations_spec.rb
  - chat_compaction_spec.rb
  - chat_content_spec.rb
  - chat_count_tokens_spec.rb
  - chat_end_user_spec.rb
  - chat_error_spec.rb
  - chat_fallbacks_spec.rb
  - chat_functions_spec.rb
  - chat_headers_spec.rb
  - chat_loop_spec.rb
  - chat_model_aliases_spec.rb
  - chat_options_spec.rb
  - chat_request_options_spec.rb
  - chat_schema_spec.rb
  - chat_server_tools_spec.rb
  - chat_spec.rb
  - chat_streaming_spec.rb
  - chat_thinking_spec.rb
  - chat_tool_approval_spec.rb
  - chat_tool_attachments_spec.rb
  - chat_tools_spec.rb
  - citation_spec.rb
  - configuration_spec.rb
  - connection_logging_spec.rb
  - connection_retry_spec.rb
  - context_spec.rb
  - cost_spec.rb
  - deprecator_spec.rb
  - embedding_spec.rb
  - error_handling_spec.rb
  - error_middleware_spec.rb
  - error_spec.rb
  - image_spec.rb
  - inspectable_spec.rb
  - instrumentation_spec.rb
  - message_spec.rb
  - model_registry_spec.rb
  - model_spec.rb
  - models_json_validation_spec.rb
  - models_local_refresh_spec.rb
  - models_merge_spec.rb
  - models_refresh_spec.rb
  - models_spec.rb
  - moderation_spec.rb
  - ocr_spec.rb
  - prompt_spec.rb
  - protocol_contract_spec.rb
  - protocol_file_preprocessing_spec.rb
  - protocol_spec.rb
  - provider_contract_spec.rb
  - provider_generator_cli_spec.rb
  - provider_scaffold_spec.rb
  - provider_spec.rb
  - rerank_spec.rb
  - search_results_spec.rb
  - speech_spec.rb
  - stream_accumulator_spec.rb
  - streaming_spec.rb
  - tool_concurrency_spec.rb
  - tool_spec.rb
  - transcription_spec.rb
  - uploaded_file_spec.rb
  - usage_spec.rb
  - utils_spec.rb
  - video_spec.rb
  - workflow_spec.rb
- - capture_instrumenter.rb
  - chat_helpers.rb
  - generator_test_helpers.rb
  - models_to_test.rb
  - rspec_configuration.rb
  - rubyllm_configuration.rb
  - simplecov_configuration.rb
  - streaming_error_helpers.rb
  - vcr_configuration.rb
- - release_tasks_spec.rb
- rails_helper.rb
- ruby_llm_gemspec_spec.rb
- ruby_llm_spec.rb
- spec_helper.rb
- models.rake
- release.rake
- vcr.rake
.env.example
.flayignore
.gitignore
.gitleaks.toml
.gitleaksignore
.overcommit.yml
.rdoc_options
.rspec
.rubocop.yml
AGENTS.md
Appraisals
Archspec.rb
CLAUDE.md
codecov.yml
CONTRIBUTING.md
Gemfile
LICENSE
mise.toml
Rakefile
README.md
ruby_llm.gemspec

# Installation Guide

ruby

Prerequisites

Ruby >= 3.0
Bundler null

Setup Steps

cp .env.example .env

Copy the environment configuration template file.

bundle install

Install the project's Ruby gem dependencies.

bin/rails generate ruby_llm:install

Generate RubyLLM Rails integration files.

bin/rails db:migrate

Run database migrations.

bundle exec rspec

Run the test suite.

Key Commands

bundle install

Install all dependency packages defined in the Gemfile.

bundle exec rspec

Run the project's RSpec tests.

bin/rails generate ruby_llm:install

Generate migrations and initializer files needed for Rails.

bin/rails db:migrate

Apply database tables and migrations.

You must configure your AI provider API keys in the .env file before running.

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

`bundle`

View Details ▼

Dependency manager for the Ruby programming language.

bundle install

Install all gems defined in the `Gemfile` expected in the working directory:

bundle exec {{command}} {{arguments}}

Execute a command in the context of the current bundle:

bundle update

Update all gems by the rules defined in the `Gemfile` and regenerate `Gemfile.lock`:

🔍

`gem`

View Details ▼

A package manager for the Ruby programming language.

gem search {{regex}} {{[-a|--all]}}

Search for remote gem(s) and show all available versions:

gem install {{gem_name}}

Install the latest version of a gem:

gem install {{gem_name}} {{[-v|--version]}} {{1.0.0}}

Install a specific version of a gem:

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

ruby_llm

Owner Repos

File Explorer

# Installation Guide

Setup Steps

Key Commands

# Use via CDN

Command Glossary

`bundle`

`gem`

Was this content helpful?

Recent Feedback

ruby_llm

Owner Repos

File Explorer

# Installation Guide

Setup Steps

Key Commands

# Use via CDN

Command Glossary

bundle

gem

Was this content helpful?

Recent Feedback

Download README

`bundle`

`gem`