ruby_llm: Instructions file for GitHub Copilot

.github/copilot-instructions.md

ruby_llm copilot-instructions.md is an instructions file for GitHub Copilot from crmne/ruby_llm. It costs 1,327 tokens per session, scanned A, original, MIT.

Repository instructions for RubyLLM, a Ruby library, covering coding, issue triage, and pull-request review. They direct the agent to follow the repository's AGENTS.md and CONTRIBUTING.md files and to preserve clear boundaries between the library's public API, stored records, providers, and protocols.

In plain words
What is it for?
Use them to review pull requests, triage issues, and write or assess RubyLLM code according to the repository's own rules.
Why use it?
They provide the project's acceptance rules before code is changed or reviewed. This helps avoid unapproved work, misplaced provider details, and changes that are hard to test or maintain.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file. Also seen: mentions AGENTS.md.

This is crmne/ruby_llm's own configuration. It tells GitHub Copilot how to work on ruby_llm itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything ruby_llm configures →

About the project

crmne/ruby_llm is a Ruby framework that provides one interface for building AI chats, agents, tools, retrieval-augmented generation, and multimodal workflows across multiple model providers. Ruby and Rails developers use it to add AI features without rewriting application code for each provider. The catalogue contains instructions and a skill for working with the framework.

crmne/ruby_llm · 4,340 stars · on GitHub · rubyllm.com

Reuse

Borrowing it

Nothing to install: this file belongs to crmne/ruby_llm. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/crmne/ruby_llm/main/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/crmne/ruby_llm

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for ruby_llm copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/crmne/ruby_llm/copilot-instructions.svg)](https://agentmods.dev/instructions/crmne/ruby_llm/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/crmne/ruby_llm/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/crmne/ruby_llm/copilot-instructions.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,327 This file is loaded in full into every session.
When invoked 1,327 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.01327 $0.01327
Opus 5 $0.00664 $0.00664
Sonnet 5 $0.00265 $0.00265
Haiku 4.5 $0.00133 $0.00133

Measured yesterday against content hash f1d65b2c93ca, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

ruby_llm copilot-instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/copilot-instructions.md · 105 lines

How it starts

The opening of the file, as written. The whole thing — 105 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Copilot instructions for RubyLLM

Use AGENTS.md and CONTRIBUTING.md as the source of truth for every change, review, and triage. AGENTS.md describes how the code is built and the boundaries Archspec.rb enforces; CONTRIBUTING.md describes what the project accepts. When they and this file disagree, they win.

The four things every change is judged on, in order: the public API reads like Ruby a Rails developer already knows; persisted Rails records behave exactly like the plain-Ruby objects; providers and protocols stay in their layers with no wire vocabulary in the domain; and the work is small, tested, documented, and free of implementation comments.

Reviewing a pull request

Read the linked issue first. A feature without an approved issue is closed without review per CONTRIBUTING.md; say so and stop.

Look for these, in this order, and treat the first four as blockers:

  • Boundary violations. Provider or protocol vocabulary in lib/ruby_llm/*.rb or lib/ruby_llm/active_record (finish reasons, error phrases, request rules, provider slugs in branches), a wire format defined inside a provider, a domain object naming RubyLLM::Providers or RubyLLM::Protocols, or Active Record reached from outside the Rails integration.
  • Guessed model metadata. Pricing, limits, cutoffs, or capabilities maintained in RubyLLM instead of models.dev, a capabilities.rb matcher over a model family, an invented model id in code, specs, or docs, or a hand edit to lib/ruby_llm/models.json, lib/ruby_llm/aliases.json, or docs/_reference/available-models.md.
  • Public API drift. A with_x without its reader, its Agent macro, or its delegate entries; a new bang method without a meaningful non-bang pair; a supports_x? predicate; a second name for an existing concept; a concept two providers share pushed through provider_options instead of getting one keyword; a raw provider Hash returned where a value object exists; a String where the gem's own enumeration is a Symbol (finish_reason, statuses, thinking effort, Model#type); an error constructor that does not take the message first.
  • Missing evidence. Behavior changes without a unit spec that fails before the fix; a changed wire request without a re-recorded cassette; a cassette with an API key or personal data in it.
  • Public API changes without RDoc, without the matching page under docs/, or without an entry in docs/_reference/upgrading.md when they break.
  • Implementation comments, drive-by refactors, style sweeps outside the touched lines, and duplication Flay would reject.

Read the full file on GitHub · 105 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 105 lines · 1,327 tokens per session scan A f1d65b2c93ca

Subscribe to this mod's changes

ruby_llm copilot-instructions.md is an instructions file published in the GitHub repository crmne/ruby_llm (4,340 stars, last pushed today), licensed MIT. It adds 1,327 tokens to every session, about $0.0066 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-05.

Related

Other instructions, from other repositories

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens