YARD(1)

📦
version 0.9.45 · 7 versions
, in ubuntu stonking

✨ NAME ✨

okay so bestie, welcome to the yard manual page — section 1, we're in the big leagues 💅 — and yard is, and I quote, a documentation tool for Ruby. that's the whole vibe, that's the assignment.

🎀 SYNOPSIS 🎀

yard command [options]

💖 DESCRIPTION 💖

so like, yard is an extensible documentation generation tool for the Ruby programming language 🔥. it lets you generate documentation that is consistent, actually usable, and exportable to a bunch of formats super easily — and it also supports being extended for custom Ruby constructs, like custom class-level definitions. it's giving "your docs but make them make sense" ✨.

below are all the commands you can pass to yard on the command line. want the tea on any specific one? run yard help command from the command line and it will spill for you 💅.

👑 COMMANDS 👑

  • config — views or edits your current global configuration 🛠️
  • diff — returns the object diff of two gems or .yardoc files 👀
  • display — displays a formatted object 💫
  • doc — generates documentation. alsoooo yardoc(1) is a synonym of yard doc, so same energy, different name 🦋
  • gems — builds the YARD index for gems 💎
  • graph — graphs a class diagram using Graphviz 📊
  • help — retrieves help for a command 🙋
  • i18n — generates a .pot file from source code and extra documentation 🌍
  • list — lists all constant and methods. uses yard doc --list 📋
  • markups — lists all available markup types and libraries 🎨
  • ri — a tool to view documentation in the console, like ri(1). and yri(1) is a synonym of yard ri 🫶
  • server — runs a local documentation server 🖥️
  • stats — prints documentation statistics on a set of files 📈

🌈 SEE ALSO 🌈

yardoc(1), yri(1).

💜 AUTHORS 💜

yard has been developed by Loren Segal <lsegal@soen.ca> 👑

this manual page has been written for the Debian Project by Cédric Boutillier — but it may be used by others 🫶 (yes, that comma crime is in the original, we keep the facts and the punctuation, periodt).

and that's the whole page, bestie!! this was the YARD(1) manual for version 0.9.45, dated 2026-07-23 — slay, ate, no crumbs left 🌸💖✨

📦 where this page comes from