# API Reference Generated from the source with RDoc. 74 classes and 56 modules. ## Brute - [`Brute`](/brute/reference/brute/) — Module Brute. - [`Brute::Compaction`](/brute/reference/brute/compaction/) — Giving up part of a conversation so the rest still fits. - [`Brute::Compaction::Middleware`](/brute/reference/brute/compaction/middleware/) — Compaction strategies, as the layers of a Brute::Turn::CompactionPipeline. - [`Brute::Compaction::Middleware::SlidingWindow`](/brute/reference/brute/compaction/middleware/sliding-window/) — When rewriting the tool output was not enough, whole stretches of the conversation go. - [`Brute::Compaction::Middleware::Strategy`](/brute/reference/brute/compaction/middleware/strategy/) — One strategy in the ladder. - [`Brute::Compaction::Middleware::ToolResults`](/brute/reference/brute/compaction/middleware/tool-results/) — The cheapest thing to give up first: what the tools said. - [`Brute::Compaction::Summarize`](/brute/reference/brute/compaction/summarize/) — Replaces stretches of the conversation with summaries of them, round after round, until it fits or there is nothing left it is allowed to give up. - [`Brute::Compaction::Transcript`](/brute/reference/brute/compaction/transcript/) — The shapes a compaction strategy selects over. - [`Brute::Completion`](/brute/reference/brute/completion/) — Completion middlewares — the terminal step of an agent turn. - [`Brute::Completion::LLMrb`](/brute/reference/brute/completion/ll-mrb/) — Completion backed by the llm.rb gem (https://github.com/llmrb/llm.rb). - [`Brute::Completion::LangChain`](/brute/reference/brute/completion/lang-chain/) — Completion backed by the langchainrb gem (https://github.com/patterns-ai-core/langchainrb). - [`Brute::Completion::OpenRouter`](/brute/reference/brute/completion/open-router/) — Class Brute::Completion::OpenRouter. - [`Brute::Completion::RubyLLM`](/brute/reference/brute/completion/ruby-llm/) — Completion backed by the ruby_llm gem. - [`Brute::Completion::RubyLLM::Tool`](/brute/reference/brute/completion/ruby-llm/tool/) — A Brute tool adapter wearing the interface ruby_llm's providers read off a RubyLLM::Tool: name, description, and a params_schema (they fall back to #paramete... - [`Brute::Contrib`](/brute/reference/brute/contrib/) — Module Brute::Contrib. - [`Brute::Contrib::LogFile`](/brute/reference/brute/contrib/log-file/) — A line-oriented, append-only log file that doubles as a work queue. - [`Brute::Contrib::Otel`](/brute/reference/brute/contrib/otel/) — OpenTelemetry for a turn, as hooks rather than middleware. - [`Brute::Diff`](/brute/reference/brute/diff/) — Module Brute::Diff. - [`Brute::Env`](/brute/reference/brute/env/) — What the turn came back with, asked of the env itself. - [`Brute::Eval`](/brute/reference/brute/eval/) — Evaluating an agent, rather than testing a middleware. - [`Brute::Eval::Case`](/brute/reference/brute/eval/case/) — One evaluation case: what the agent is told, the world it is told it in, and what must be true of the turn afterwards. - [`Brute::Eval::Suite`](/brute/reference/brute/eval/suite/) — Runs the cases against one agent and reports what happened. - [`Brute::Eval::Transcript`](/brute/reference/brute/eval/transcript/) — What one turn did. - [`Brute::Eval::World`](/brute/reference/brute/eval/world/) — The world a case wakes up in. - [`Brute::Events`](/brute/reference/brute/events/) — @namespace - [`Brute::Events::Handler`](/brute/reference/brute/events/handler/) — Stackable event handler base class. - [`Brute::Events::PrefixedTerminalOutput`](/brute/reference/brute/events/prefixed-terminal-output/) — TerminalOutput variant that prefixes all output with a label. - [`Brute::Events::TerminalOutput`](/brute/reference/brute/events/terminal-output/) — Class Brute::Events::TerminalOutput. - [`Brute::Hooks`](/brute/reference/brute/hooks/) — Pub/sub registry for agent lifecycle hooks, subscribed on the builder: - [`Brute::Hooks::Registry`](/brute/reference/brute/hooks/registry/) — The pub/sub registry a pipeline owns; use and run bind an emit to it. - [`Brute::Hooks::Trace`](/brute/reference/brute/hooks/trace/) — The env, wrapped, for as long as one call lasts. - [`Brute::MessageTransport`](/brute/reference/brute/message-transport/) — Class Brute::MessageTransport. - [`Brute::MessageTransport::Anthropic`](/brute/reference/brute/message-transport/anthropic/) — MessageTransport for the official anthropic gem (https://github.com/anthropics/anthropic-sdk-ruby). - [`Brute::MessageTransport::LLM`](/brute/reference/brute/message-transport/llm/) — MessageTransport for the llm.rb gem (https://github.com/llmrb/llm.rb). - [`Brute::MessageTransport::LangChain`](/brute/reference/brute/message-transport/lang-chain/) — MessageTransport for the langchainrb gem. - [`Brute::MessageTransport::OpenAI`](/brute/reference/brute/message-transport/open-ai/) — MessageTransport for the official openai gem (https://github.com/openai/openai-ruby). - [`Brute::MessageTransport::OpenRouter`](/brute/reference/brute/message-transport/open-router/) — MessageTransport for the open_router_enhanced gem (https://github.com/estiens/open_router_enhanced). - [`Brute::MessageTransport::RubyLLM`](/brute/reference/brute/message-transport/ruby-llm/) — MessageTransport for the ruby_llm gem (https://github.com/crmne/ruby_llm). - [`Brute::MessageTransport::RubyLLM::V1`](/brute/reference/brute/message-transport/ruby-llm/v1/) — ruby_llm 1.x. - [`Brute::MessageTransport::RubyLLM::V2`](/brute/reference/brute/message-transport/ruby-llm/v2/) — ruby_llm 2.0 and later. - [`Brute::MessageTransport::RubyOpenAI`](/brute/reference/brute/message-transport/ruby-open-ai/) — Class Brute::MessageTransport::RubyOpenAI. - [`Brute::Messages`](/brute/reference/brute/messages/) — The in-memory conversation log is just a plain Array of Brute::Message. - [`Brute::Middleware`](/brute/reference/brute/middleware/) — Module Brute::Middleware. - [`Brute::Middleware::Base`](/brute/reference/brute/middleware/base/) — The parent of every middleware: it takes the next app, does its work around it, and calls it. - [`Brute::Middleware::Checkpoint`](/brute/reference/brute/middleware/checkpoint/) — Durable execution for the tool loop. - [`Brute::Middleware::DefaultCompactionPipeline`](/brute/reference/brute/middleware/default-compaction-pipeline/) — Compacts the conversation once it fills too much of the model's window. - [`Brute::Middleware::DefaultCompactionPipeline::Declines`](/brute/reference/brute/middleware/default-compaction-pipeline/declines/) — The floor of a pipeline given nothing to summarise with: what the free layers managed is what the turn gets. - [`Brute::Middleware::DefaultToolPipeline`](/brute/reference/brute/middleware/default-tool-pipeline/) — Class Brute::Middleware::DefaultToolPipeline. - [`Brute::Middleware::Loop`](/brute/reference/brute/middleware/loop/) — Re-invokes the inner stack as long as a condition holds — a generic loop over a turn. - [`Brute::Middleware::Loop::BackgroundJobs`](/brute/reference/brute/middleware/loop/background-jobs/) — Keeps the turn alive while background jobs are running. - [`Brute::Middleware::Loop::ToolResult`](/brute/reference/brute/middleware/loop/tool-result/) — Loops while the LLM keeps producing tool results — the standard agentic turn loop. - [`Brute::Middleware::MaxIterations`](/brute/reference/brute/middleware/max-iterations/) — Guards against runaway tool loops by capping the number of iterations. - [`Brute::Middleware::Question`](/brute/reference/brute/middleware/question/) — Class Brute::Middleware::Question. - [`Brute::Middleware::SessionLog`](/brute/reference/brute/middleware/session-log/) — The "session" is just a JSONL log of the conversation on disk. - [`Brute::Middleware::Skills`](/brute/reference/brute/middleware/skills/) — Loads skill objects into the agent context. - [`Brute::Middleware::SlashCommands`](/brute/reference/brute/middleware/slash-commands/) — The head of every agent chain, put there by the builder itself rather than by a use anyone writes. - [`Brute::Middleware::Summarize`](/brute/reference/brute/middleware/summarize/) — Runs a final tool-free LLM call after the Loop::ToolResult completes, ensuring the agent produces a clean summary response. - [`Brute::Middleware::SystemPrompt`](/brute/reference/brute/middleware/system-prompt/) — Prepends a system message to env[:messages] before passing control down the middleware chain. - [`Brute::Middleware::UserQueue`](/brute/reference/brute/middleware/user-queue/) — Class Brute::Middleware::UserQueue. - [`Brute::PromptTemplate`](/brute/reference/brute/prompt-template/) — An ERB-backed system-prompt object for Middleware::SystemPrompt — the open alternative to Brute::SystemPrompt's built-in section stacks. - [`Brute::Prompts`](/brute/reference/brute/prompts/) — Module Brute::Prompts. - [`Brute::Prompts::Autonomy`](/brute/reference/brute/prompts/autonomy/) — Module Brute::Prompts::Autonomy. - [`Brute::Prompts::BuildSwitch`](/brute/reference/brute/prompts/build-switch/) — Module Brute::Prompts::BuildSwitch. - [`Brute::Prompts::CodeReferences`](/brute/reference/brute/prompts/code-references/) — Module Brute::Prompts::CodeReferences. - [`Brute::Prompts::CodeStyle`](/brute/reference/brute/prompts/code-style/) — Module Brute::Prompts::CodeStyle. - [`Brute::Prompts::Context`](/brute/reference/brute/prompts/context/) — Template context handed to ERB templates. - [`Brute::Prompts::Conventions`](/brute/reference/brute/prompts/conventions/) — Module Brute::Prompts::Conventions. - [`Brute::Prompts::DoingTasks`](/brute/reference/brute/prompts/doing-tasks/) — Module Brute::Prompts::DoingTasks. - [`Brute::Prompts::EditingApproach`](/brute/reference/brute/prompts/editing-approach/) — Module Brute::Prompts::EditingApproach. - [`Brute::Prompts::EditingConstraints`](/brute/reference/brute/prompts/editing-constraints/) — Module Brute::Prompts::EditingConstraints. - [`Brute::Prompts::Environment`](/brute/reference/brute/prompts/environment/) — Module Brute::Prompts::Environment. - [`Brute::Prompts::FrontendTasks`](/brute/reference/brute/prompts/frontend-tasks/) — Module Brute::Prompts::FrontendTasks. - [`Brute::Prompts::GitSafety`](/brute/reference/brute/prompts/git-safety/) — Module Brute::Prompts::GitSafety. - [`Brute::Prompts::Identity`](/brute/reference/brute/prompts/identity/) — Module Brute::Prompts::Identity. - [`Brute::Prompts::Instructions`](/brute/reference/brute/prompts/instructions/) — Module Brute::Prompts::Instructions. - [`Brute::Prompts::MaxSteps`](/brute/reference/brute/prompts/max-steps/) — Module Brute::Prompts::MaxSteps. - [`Brute::Prompts::Objectivity`](/brute/reference/brute/prompts/objectivity/) — Module Brute::Prompts::Objectivity. - [`Brute::Prompts::PlanReminder`](/brute/reference/brute/prompts/plan-reminder/) — Module Brute::Prompts::PlanReminder. - [`Brute::Prompts::Proactiveness`](/brute/reference/brute/prompts/proactiveness/) — Module Brute::Prompts::Proactiveness. - [`Brute::Prompts::SecurityAndSafety`](/brute/reference/brute/prompts/security-and-safety/) — Module Brute::Prompts::SecurityAndSafety. - [`Brute::Prompts::Skills`](/brute/reference/brute/prompts/skills/) — The system-prompt section. - [`Brute::Prompts::TaskManagement`](/brute/reference/brute/prompts/task-management/) — Module Brute::Prompts::TaskManagement. - [`Brute::Prompts::ToneAndStyle`](/brute/reference/brute/prompts/tone-and-style/) — Module Brute::Prompts::ToneAndStyle. - [`Brute::Prompts::ToolUsage`](/brute/reference/brute/prompts/tool-usage/) — Module Brute::Prompts::ToolUsage. - [`Brute::Rack`](/brute/reference/brute/rack/) — The mirror image of protocol-rack. - [`Brute::Rack::Adapter`](/brute/reference/brute/rack/adapter/) — Class Brute::Rack::Adapter. - [`Brute::Skill`](/brute/reference/brute/skill/) — A single skill: metadata plus the address of its SKILL.md on disk. - [`Brute::SystemPrompt`](/brute/reference/brute/system-prompt/) — Deferred system prompt builder. - [`Brute::TokenCounter`](/brute/reference/brute/token-counter/) — How big a conversation is, in tokens. - [`Brute::TokenCounter::Approximate`](/brute/reference/brute/token-counter/approximate/) — Tokens from text length, at a flat ratio of characters to tokens. - [`Brute::TokenCounter::Rendering`](/brute/reference/brute/token-counter/rendering/) — The text a counter measures. - [`Brute::TokenCounter::Tiktoken`](/brute/reference/brute/token-counter/tiktoken/) — Tokens from OpenAI's byte-pair encoder, through the tiktoken_ruby gem. - [`Brute::Tool`](/brute/reference/brute/tool/) — Base class for Brute's built-in tools — a tiny, framework-agnostic tool DSL. - [`Brute::Tools`](/brute/reference/brute/tools/) — Module Brute::Tools. - [`Brute::Tools::Adapter`](/brute/reference/brute/tools/adapter/) — Normalizes any tool shape into one neutral interface so the rest of Brute never has to care which tools library (if any) a tool was written with. - [`Brute::Tools::FS`](/brute/reference/brute/tools/fs/) — @namespace --- @namespace - [`Brute::Tools::FS::FileMutationQueue`](/brute/reference/brute/tools/fs/file-mutation-queue/) — Per-file serialization queue for concurrent tool execution. - [`Brute::Tools::FS::SnapshotStore`](/brute/reference/brute/tools/fs/snapshot-store/) — Per-path stack of file snapshots used by fs_write, fs_patch, fs_remove to enable undo. - [`Brute::Tools::FSPatch`](/brute/reference/brute/tools/fs-patch/) — Class Brute::Tools::FSPatch. - [`Brute::Tools::FSRead`](/brute/reference/brute/tools/fs-read/) — Existing features (ref: opencode read tool): - [`Brute::Tools::FSRemove`](/brute/reference/brute/tools/fs-remove/) — Class Brute::Tools::FSRemove. - [`Brute::Tools::FSSearch`](/brute/reference/brute/tools/fs-search/) — Existing features (ref: opencode grep tool): - [`Brute::Tools::FSUndo`](/brute/reference/brute/tools/fs-undo/) — Class Brute::Tools::FSUndo. - [`Brute::Tools::FSWrite`](/brute/reference/brute/tools/fs-write/) — Class Brute::Tools::FSWrite. - [`Brute::Tools::NetFetch`](/brute/reference/brute/tools/net-fetch/) — Class Brute::Tools::NetFetch. - [`Brute::Tools::Question`](/brute/reference/brute/tools/question/) — Class Brute::Tools::Question. - [`Brute::Tools::Shell`](/brute/reference/brute/tools/shell/) — Existing features (ref: opencode bash tool): - [`Brute::Tools::SkillLoad`](/brute/reference/brute/tools/skill-load/) — The skill tool — stages 2 (activation) and 3 (execution) of the Agent Skills progressive-disclosure lifecycle (https://agentskills.io). - [`Brute::Tools::SubAgent`](/brute/reference/brute/tools/sub-agent/) — A SubAgent is an Agent that exposes a tool-shaped facade so it can be dropped into another agent's tools list. - [`Brute::Tools::TodoList`](/brute/reference/brute/tools/todo-list/) — @namespace - [`Brute::Tools::TodoList::Store`](/brute/reference/brute/tools/todo-list/store/) — In-memory todo list storage. - [`Brute::Tools::TodoRead`](/brute/reference/brute/tools/todo-read/) — Class Brute::Tools::TodoRead. - [`Brute::Tools::TodoWrite`](/brute/reference/brute/tools/todo-write/) — Class Brute::Tools::TodoWrite. - [`Brute::Truncation`](/brute/reference/brute/truncation/) — Universal tool output truncation. - [`Brute::Turn`](/brute/reference/brute/turn/) — Module Brute::Turn. - [`Brute::Turn::AgentPipeline`](/brute/reference/brute/turn/agent-pipeline/) — agent = Brute.agent # => AgentPipeline - [`Brute::Turn::CompactionPipeline`](/brute/reference/brute/turn/compaction-pipeline/) — A compactor built out of middleware. - [`Brute::Turn::Pipeline`](/brute/reference/brute/turn/pipeline/) — Class Brute::Turn::Pipeline. - [`Brute::Turn::Pipeline::Chainable`](/brute/reference/brute/turn/pipeline/chainable/) — Module Brute::Turn::Pipeline::Chainable. - [`Brute::Turn::ToolPipeline`](/brute/reference/brute/turn/tool-pipeline/) — A ToolPipeline runs a tool call through a middleware stack. - [`Brute::UsageDetection`](/brute/reference/brute/usage-detection/) — What the provider reported, normalised. - [`Brute::UsageDetection::LLMrb`](/brute/reference/brute/usage-detection/ll-mrb/) — llm.rb models usage as its own LLM::Usage value object. - [`Brute::UsageDetection::LangChain`](/brute/reference/brute/usage-detection/lang-chain/) — langchainrb has no single usage object: each provider's response subclass answers prompt_tokens / completion_tokens / total_tokens by digging its own raw sha... - [`Brute::UsageDetection::OpenRouter`](/brute/reference/brute/usage-detection/open-router/) — OpenRouter reports usage as the provider's raw hash on the response, in OpenAI's wire shape. - [`Brute::UsageDetection::RubyLLM`](/brute/reference/brute/usage-detection/ruby-llm/) — ruby_llm hangs usage off the message, not the response: a Tokens object with input/output/cache_read/cache_write/thinking, plus the provider's own reported_c... ## BruteCLI - [`BruteCLI`](/brute/reference/brute-cli/) — Module BruteCLI. - [`BruteCLI::Providers`](/brute/reference/brute-cli/providers/) — Module BruteCLI::Providers. - [`BruteCLI::Providers::Shell`](/brute/reference/brute-cli/providers/shell/) — A pseudo-LLM provider that executes user input as code via the existing Brute::Tools::Shell tool. - [`BruteCLI::Providers::Shell::ModelList`](/brute/reference/brute-cli/providers/shell/model-list/) — Minimal object that quacks like provider.models so the REPL's fetch_models can call provider.models.all.select(&:chat?). - [`BruteCLI::Providers::ShellResponse`](/brute/reference/brute-cli/providers/shell-response/) — Synthetic completion response returned by Brute::Providers::Shell.