YRI(1)

📦
version 0.9.45 · 7 versions
, in ubuntu stonking

💖 YRI(1) 💖

okay bestie, welcome to the yri manual page — that's the console docs tool for Ruby, and yes we're gonna read the whole thing together, no skimming, I got you 🫶

✨ NAME ✨

yri — documentation tool in console for Ruby. it's giving "man pages but make it Ruby" 💅

🌸 SYNOPSIS 🌸

yri [options] Path_to_object

that's it. that's the whole vibe. options go first, then the thing you wanna look up 👑

🦋 DESCRIPTION 🦋

so like, context first: yard(1) is an extensible documentation generation tool for the Ruby programming language. it lets the user generate consistent, usable documentation that can be exported to a number of formats very easily, and it also supports extending for custom Ruby constructs such as custom class level definitions. iconic behavior fr fr ✨

and yri(1)? it's a synonym for yard ri. it gives you the possibility to read the documentation for Ruby programs inside a console, pretty much like ri(1) does. so if you already fw ri(1), this is your new main character 🌈

🎀 OPTIONS 🎀

General Options: 💖

  • -b, --db FILE — use a specified .yardoc db to search in 🔍
  • -T, --no-pager — no pager. straight to stdout, no scrolling little guy, raw and unfiltered 😌
  • -p, --pager PAGER — use PAGER as a pager (yes you can pick your own, go off 🫶)

Other options: 🧚

  • -e, --load FILE — a Ruby script to load before running command. pre-game warmup script, love that for us 💅
  • --plugin PLUGIN — load a YARD plugin (that's a gem with the yard- prefix, iykyk)
  • --legacy — use old style Ruby parser and handlers. and heads up bestie, it's always on in 1.8.x ⚠️
  • --safe — enable safe mode for this instance 🛡️
  • -q, --quiet — show no warnings. silence is golden, the drama is cancelled 🙈
  • --verbose — show more information. tell me everything, I wanna know 👀
  • --debug — show debugging information. deep lore unlocked 🔥
  • --backtrace — show stack traces 🪜
  • -v, --version — show version 📌
  • -h, --help — show a help message, similar to this page. hi bestie, this one's you right now 😭

⭐ EXAMPLES ⭐

yri String#gsub

literally the moment. look up String#gsub, get the docs, slay 💖

🌈 SEE ALSO 🌈

yard(1) — that's the big sibling, go say hi 🫶

👑 AUTHORS 👑

yard has been developed by Loren Segal <lsegal@soen.ca>. thank you king 🫡

This manual page has been written for the Debian Project by Cédric Boutillier (but may used by others). appreciation post for Cédric, fr fr 💜

ok and that's the whole page bestie, you ate that 🎀✨

sign-off time: this was version 0.9.45, dated 2026-07-23 — mwah, go read some Ruby docs, ily, bye 💅💖

📦 where this page comes from