llm.rb 12.2.0 → 12.3.1

data/resources/deepdive.md

@@ -25,44 +25,126 @@ features that didn't make it into the homepage documentation.
 
 ## Table of contents
 
-- [Agents](#agents)
-  - [As a subclass](#as-a-subclass)
-  - [As an object](#as-an-object)
-- [Skills](#skills)
-  - [SKILL.md](#skillmd)
-  - [Run it](#run-it)
-- [MCP](#mcp)
-  - [stdio](#stdio)
-  - [http](#http)
-- [A2A](#a2a)
-  - [rest](#rest)
-  - [jsonrpc](#jsonrpc)
-- [Transports](#transports)
-  - [net/http](#nethttp)
-  - [net/http/persistent](#nethttppersistent)
-  - [curb](#curb)
-- [Stream](#stream)
-  - [IO-like object](#io-like-object)
-  - [LLM::Stream](#llmstream)
-- [ORM](#orm)
-  - [ActiveRecord](#activerecord)
-  - [Sequel](#sequel)
-- [Schema](#schema)
-  - [Estimation](#estimation)
-- [Cancellation](#cancellation)
-  - [Cancel a request](#cancel-a-request)
-- [Tracer](#tracer)
-  - [Provider-wide tracer](#provider-wide-tracer)
-  - [Agent-local tracer](#agent-local-tracer)
-- [REPL](#repl)
-  - [LLM::Agent](#llmagent)
-- [Images](#images)
-  - [Generation](#generation)
-  - [Edits](#edits)
-- [Audio](#audio)
-  - [text-to-speech](#text-to-speech)
-  - [speech-to-text](#speech-to-text)
-  - [translation](#translation)
+**Overview**
+
+- [Welcome](#welcome)
+
+**Core**
+
+<details>
+<summary>Agents</summary>
+
+- [As a subclass](#as-a-subclass)
+- [As an object](#as-an-object)
+</details>
+
+<details>
+<summary>Tools</summary>
+
+- [LLM::Tool](#llmtool)
+- [Errors](#errors)
+</details>
+
+<details>
+<summary>Skills</summary>
+
+- [SKILL.md](#skillmd)
+- [Run it](#run-it)
+</details>
+
+<details>
+<summary>Schema</summary>
+
+- [Estimation](#estimation)
+</details>
+
+**Runtime**
+
+<details>
+<summary>Stream</summary>
+
+- [IO-like object](#io-like-object)
+- [LLM::Stream](#llmstream)
+</details>
+
+<details>
+<summary>Cancellation</summary>
+
+- [Cancel a request](#cancel-a-request)
+</details>
+
+<details>
+<summary>Transports</summary>
+
+- [net/http](#nethttp)
+- [net/http/persistent](#nethttppersistent)
+- [curb](#curb)
+</details>
+
+<details>
+<summary>Tracer</summary>
+
+- [Provider-wide tracer](#provider-wide-tracer)
+- [Agent-local tracer](#agent-local-tracer)
+</details>
+
+<details>
+<summary>REPL</summary>
+
+- [LLM::Agent](#llmagent)
+- [Tools](#tools)
+- [Skills](#skills-1)
+- [Tracer](#tracer-1)
+</details>
+
+**Persistence**
+
+<details>
+<summary>Serialization</summary>
+
+- [Save to disk](#save-to-disk)
+</details>
+
+<details>
+<summary>ORM</summary>
+
+- [ActiveRecord](#activerecord)
+- [Sequel](#sequel)
+</details>
+
+**Media**
+
+<details>
+<summary>Images</summary>
+
+- [Generation](#generation)
+- [Edits](#edits)
+- [DeepSeek](#deepseek)
+</details>
+
+<details>
+<summary>Audio</summary>
+
+- [text-to-speech](#text-to-speech)
+- [speech-to-text](#speech-to-text)
+- [translation](#translation)
+</details>
+
+**Protocols**
+
+<details>
+<summary>MCP</summary>
+
+- [stdio](#stdio)
+- [http](#http)
+</details>
+
+<details>
+<summary>A2A</summary>
+
+- [rest](#rest)
+- [jsonrpc](#jsonrpc)
+</details>
 
 ## Agents
 
@@ -808,21 +890,22 @@ agent = LLM::Agent.new(llm, tracer: LLM::Tracer::Logger.new(llm, path: "deepseek
 
 During the development and operation of agents it can often
 be helpful to drop into a read-eval-print loop. This gives
-you a simple way to confirm the work was successful, inspect
-anything that went wrong (for example, tool call errors), and
-keep talking to the same agent so you can learn about its
-decision-making process and make improvements for future runs.
-It can also be used to ask the agent to correct any errors
-that might have made.
+you a way to confirm the work was successful, inspect
+anything that went wrong, and keep talking to the same
+agent while its state is still intact.
 
-##### LLM::Agent
+#### LLM::Agent
 
 The [LLM::Agent#repl](https://r.uby.dev/api-docs/llm.rb/LLM/Agent.html#repl-instance_method)
-method requires the [curses](https://github.com/ruby/curses)
-gem to be installed and available for require. It is an
-optional dependency that only becomes required when you
-call the [LLM::Agent#repl](https://r.uby.dev/api-docs/llm.rb/LLM/Agent.html#repl-instance_method)
-method.
+method allows an agent to spawn a read-eval-print loop
+that can be useful while developing or operating agents.
+It can be used to debug tool calls, confirm an
+agent has done what was expected, or improve an agent by
+asking questions about what it has done up to that point.
+
+This feature requires that the [curses](https://github.com/ruby/curses)
+and [kramdown](https://github.com/gettalong/kramdown) libraries are
+installed and available to require.
 
 ```ruby
 require "llm"
@@ -832,6 +915,43 @@ agent = LLM::Agent.new(llm)
 agent.repl
 ```
 
+#### Tools
+
+The read-eval-print loop accepts a `tools` option that lets
+you attach additional tools for the duration of the session.
+
+```ruby
+llm = LLM.deepseek(key: ENV["KEY"])
+agent = LLM::Agent.new(llm)
+agent.repl(tools: [Debugger])
+```
+
+#### Skills
+
+The read-eval-print loop also accepts a `skills` option.
+This can be useful when you want to load extra skills
+without attaching them to an agent permanently.
+
+```ruby
+llm = LLM.deepseek(key: ENV["KEY"])
+agent = LLM::Agent.new(llm)
+agent.repl(skills: [__dir__])
+```
+
+#### Tracer
+
+By default the tracer is disabled for the duration of the
+session. This can be configured through the
+`tracer` option. Setting it to `true` will configure
+the REPL to use the tracer associated with an instance
+of [`LLM::Agent`](https://r.uby.dev/api-docs/llm.rb/LLM/Agent.html).
+
+```ruby
+llm = LLM.deepseek(key: ENV["KEY"])
+agent = LLM::Agent.new(llm, tracer: LLM.logger(llm, path: "agent.log"))
+agent.repl(tracer: true, tools: [Debugger])
+```
+
 [Back to top](#table-of-contents)
 
 ## Images

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llm.rb
 version: !ruby/object:Gem::Version
-  version: 12.2.0
+  version: 12.3.1
 platform: ruby
 authors:
 - robert
@@ -277,8 +277,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.18'
-description: llm.rb is not a library, framework or toolkit but an advanced runtime
-  for building highly capable AI applications on CRuby.
+description: |
+  llm.rb is an advanced runtime for building capable AI applications
+  on CRuby. By default it has zero runtime dependencies although certain
+  functionality – such as ActiveRecord support – require
+  optional dependencies that are opt-in.
 email:
 - robert@r.uby.dev
 executables: []
@@ -464,7 +467,9 @@ files:
 - lib/llm/providers/zai.rb
 - lib/llm/registry.rb
 - lib/llm/repl.rb
+- lib/llm/repl/bar.rb
 - lib/llm/repl/input.rb
+- lib/llm/repl/markdown.rb
 - lib/llm/repl/status.rb
 - lib/llm/repl/stream.rb
 - lib/llm/repl/transcript.rb
@@ -492,6 +497,8 @@ files:
 - lib/llm/session.rb
 - lib/llm/skill.rb
 - lib/llm/stream.rb
+- lib/llm/stream/disabled.rb
+- lib/llm/stream/io.rb
 - lib/llm/stream/queue.rb
 - lib/llm/tool.rb
 - lib/llm/tool/param.rb