Project

ruby_llm-ag_ui

0.0
The project is in a healthy, maintained state
ruby_llm-ag_uiyorzi/ruby_llm-ag-uiHomepageDocumentationSource CodeBug Tracker
An unofficial RubyLLM ecosystem extension that turns one RubyLLM 2.x chat turn into one AG-UI 1.0 run. It parses and validates RunAgentInput, maps RubyLLM streaming, tool and lifecycle behavior onto schema-valid AG-UI events, turns requires_approval pauses into interrupt outcomes with host-authorized resume, reports cancellation as the cancelled outcome, and ships an SSE writer for plain Ruby plus an optional Rails adapter.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Popularity
Downloads
291
Stars
0
Forks
0
Watchers
0
 Releases
Current version
0.2.0
Total releases
2
First release
2026-10-18
Latest release
2026-10-19
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2026-10-18
Reverse Dependencies
0

 Dependencies

Runtime

ag-ui-protocol
~> 0.2.0
cgi
>= 0.4.2, < 1
resolv
>= 0.7.2, < 1
ruby_llm
>= 2.1, < 3.0
uri
>= 1.0.4, < 2
zlib
>= 3.2.3, < 4
 Project Readme

ruby_llm-ag_ui

CI

Connect RubyLLM chats to AG-UI clients over Server-Sent Events. The gem handles streaming text, tool calls, approval and resume, cancellation outcomes, and run identity. Use it from plain Ruby or with the optional Rails adapter.

Your application provides authentication, tool permissions, chat history, and the model. This is an unofficial community project, independent of the RubyLLM and AG-UI maintainers.

Documentation · Getting started · Rails guide · Compatibility

Install

gem 'ruby_llm-ag_ui', '~> 0.2.0'

Requires Ruby >= 3.2, RubyLLM >= 2.1 and < 3.0, and ag-ui-protocol 0.2.x. Run bundle install after adding the gem.

Stream a run

Pass a chat authorized for the current actor, a shared run store, and an IO-like response stream from your application:

require 'ruby_llm/ag_ui'

input = RubyLLM::AgUI::Input.parse(request_body)
chat = authorized_chat_for(current_user, input.thread_id)

RubyLLM::AgUI::Run.new(
  chat: chat,
  input: input,
  scope: "actor:#{current_user.id}",
  store: run_store
).stream(to: response_stream)

Build scope from authenticated identity. See the streaming guide for setup and the examples for integration code.

Development

bundle install
bundle exec rspec
bundle exec rubocop
bundle exec rake example # offline approval and resume demo, no API key needed

The default suite is offline. Real client and provider verification is tracked in the compatibility guide. See CONTRIBUTING.md for development and documentation rules, ROADMAP.md for the proposed path to 1.0, and CHANGELOG.md for shipped changes.

License and security

MIT. See the third-party notices and report vulnerabilities through SECURITY.md.