ruchy-book: Instructions file for Gemini CLI

GEMINI.md

ruchy-book GEMINI.md is an instructions file for Gemini CLI from paiml/ruchy-book. It costs 642 tokens per session, scanned A, original, MIT.

Project instructions for the official book about Ruchy, a programming language. They describe its tools and workflow, including TDD, where tests are written before the code or documentation they verify, and mdBook, which turns Markdown into a book website.

In plain words
What is it for?
Use them when adding or checking Ruchy examples, building the book, running its Rust tests, or maintaining Deno and Make-based workflows.
Why use it?
They help keep every documented code example tested and consistent with the pinned compiler and build process.

Instructions file for Gemini CLI

Written for Gemini CLI: the file is GEMINI.md.

This is paiml/ruchy-book's own configuration. It tells Gemini CLI how to work on ruchy-book 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 ruchy-book configures →

Reuse

Borrowing it

Nothing to install: this file belongs to paiml/ruchy-book. 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/paiml/ruchy-book/main/GEMINI.md
Clone the repo
git clone --depth 1 https://github.com/paiml/ruchy-book

Made for: Gemini CLI.

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 ruchy-book GEMINI.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/paiml/ruchy-book/gemini-md/github.svg)](https://agentmods.dev/instructions/paiml/ruchy-book/gemini-md)
Your own site
<a href="https://agentmods.dev/instructions/paiml/ruchy-book/gemini-md"><img src="https://agentmods.dev/badge/instructions/paiml/ruchy-book/gemini-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for ruchy-book GEMINI.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/paiml/ruchy-book/gemini-md"><img src="https://agentmods.dev/badge/instructions/paiml/ruchy-book/gemini-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 642 This file is loaded in full into every session.
When invoked 642 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.00642 $0.00642
Opus 5.5 $0.00257 $0.00257
Sonnet 5.5 $0.00128 $0.00128
Haiku 4.5 $0.00064 $0.00064

Measured 2mo ago against content hash 3cb2b177b341, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

ruchy-book GEMINI.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 2mo ago.

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.

GEMINI.md · 65 lines

How it starts

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

Gemini Project Context

This document provides context for the Gemini AI assistant to understand the Ruchy Book project.

Project Overview

This project is the official book for the Ruchy programming language, developed with a strict Test-Driven Development (TDD) methodology. All code examples are first written as tests and verified before being included in the documentation. The book is built using mdbook.

The core philosophy is: "Test first, document what works, never promise what doesn't exist."

Technology Stack

  • Ruchy (ruchy): The programming language being documented. The project is pinned to a specific version of the ruchy compiler.
  • mdBook (mdbook): A utility to create books from Markdown files. Used to build the final HTML version of the book.
  • Rust: The integration test suite that validates all Ruchy code examples is written in Rust. Cargo.toml defines the testing dependencies.
  • Deno: Used for scripting various development and workflow tasks, such as extracting examples, running tests, and generating reports. Configuration is in deno.json.

Development Workflow

The development process is centered around make and deno tasks.

Key Commands

  • Run all tests:
    make test
    
  • Build the book:
    mdbook build
    
  • Serve the book locally:
    mdbook serve
    
  • Run lint checks:
    make dogfood-quick
    
  • Run Deno-based scripts:
    deno task <task_name>
    
    (e.g., deno task test-oneliners, deno task extract-examples)

TDD Process for New Content

  1. Write a test: Add a new .ruchy file in the tests/ directory.
  2. Verify the test: Run the test to ensure it works as expected.
  3. Document the feature: Add the explanation and code to a Markdown file in src/.
  4. Validate: Run make validate to ensure all checks pass.

Project Structure

  • src/: Contains the Markdown source files for the book's chapters.
  • tests/: Contains the Ruchy code examples, which double as integration tests.
  • book/: The output directory for the built book (generated by mdbook).
  • scripts/: Deno scripts for automation (testing, linting, reports).
  • book.toml: mdbook configuration file.
  • Cargo.toml: Rust project file for the test harness.
  • deno.json: Deno configuration and task definitions.
  • Makefile: Defines the main entry points for development tasks.
  • INTEGRATION.md: The single source of truth for project status, test results, and quality metrics.

Read the full file on GitHub · 65 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. 2mo ago First seen · 65 lines · 642 tokens per session scan A 3cb2b177b341

Subscribe to this mod's changes

ruchy-book GEMINI.md is an instructions file published in the GitHub repository paiml/ruchy-book (11 stars, last pushed yesterday), licensed MIT. It adds 642 tokens to every session, about $0.0026 per session on Opus 5.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-08-30.

Related

Other instructions, from other repositories

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 · 9,715 tokens

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,461 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, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 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,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,750 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,261 tokens