RAKE(1)

✨ RAKE(1) — NAME ✨

rake 💖 is a make-like build utility for Ruby, and bestie, it is literally so good. The manual name is rake(1), which I am obsessed with.

Quick note before we start: the em-dash and the header stuff are just the page's little intro, so I'm keeping the vibe but not the formatting.

🎀 SYNOPSIS 🎀

rake [-f rakefile] [options] targets ...

🌸 DESCRIPTION 🌸

okay so rake is a make(1)-like build utility for Ruby 🔥. Tasks and dependencies get written in standard Ruby syntax, so if you already speak Ruby you're basically fluent already 💅.

💅 OPTIONS 💅

• -m, --multitask — treat all tasks as multitasks ✨
• -B, --build-all — build all prerequisites, even the ones that are already up-to-date 🫶
• -j, --jobs num_jobs — sets the max number of tasks that can run in parallel (default is number of CPU cores + 4) 🔥

🧚 Modules 🧚

• -I, --libdir libdir — adds libdir to the search path for required modules 🦋
• -r, --require module — requires module before running the rakefile 💜

🗺️ Rakefile location 🗺️

• -f, --rakefile filename — uses filename as the rakefile to look for 🍓
• -N, --no-search, --nosearch — don't search parent directories for the Rakefile 🙈
• -G, --no-system, --nosystem — use the standard project Rakefile search paths and ignore system-wide rakefiles 🌈
• -R, --rakelib rakelibdir, --rakelibdir rakelibdir — auto-imports any .rake files in rakelibdir (default is ‘rakelib’) 🎀
• -g, --system — uses system-wide (global) rakefiles (usually ~/.rake/*.rake) ✨

🐛 Debugging 🐛

• --backtrace=out — enables the full backtrace. out can be stderr (default) or stdout 💀
• -t, --trace=out — turns on invoke/execute tracing and enables full backtrace. out can be stderr (default) or stdout 👑
• --suppress-backtrace pattern — suppresses backtrace lines matching the regexp pattern. Ignored if --trace is on 🙈
• --rules — traces the rules resolution 🦋
• -n, --dry-run — does a dry run without executing actions 🫶
• -T, --tasks [pattern] — displays the tasks (matching the optional pattern) with descriptions, then exits 💖
• -D, --describe [pattern] — describes the tasks (matching the optional pattern), then exits 🌸
• -W, --where [pattern] — describes the tasks (matching the optional pattern), then exits 💜
• -P, --prereqs — displays the tasks and dependencies, then exits 🧚
• -e, --execute code — executes some Ruby code and exits ✨
• -p, --execute-print code — executes some Ruby code, prints the result, then exits 🍓
• -E, --execute-continue code — executes some Ruby code, then continues with normal task processing 🔥

📣 Information 📣

• -v, --verbose — logs messages to standard output 🌈
• -q, --quiet — doesn't log messages to standard output 🙈
• -s, --silent — like --quiet, but also suppresses the ‘in directory’ announcement 🤫
• -X, --no-deprecation-warnings — disables the deprecation warnings 💀
• --comments — shows commented tasks only 🎀
• -A, --all — shows all tasks, even uncommented ones (in combination with -T or -D) ✨
• --job-stats [level] — displays job statistics. If level is ‘history’, it displays a complete job list 🦋
• -V, --version — displays the program version 👑
• -h, -H, --help — displays a help message 💜

🦋 SEE ALSO 🦋

okay the complete documentation for rake has been installed at /usr/share/doc/rake-doc/html/index.html, and it's also available online at https://ruby.github.io/rake 🌸

👑 AUTHORS 👑

rake was written by Jim Weirich <jim@weirichhouse.org> 💖

This manual was created by Caitlin Matos <caitlin.matos@zoho.com> for the Debian project (but may be used by others). It was inspired by the manual by Jani Monoses <jani@iv.ro> for the Ubuntu project 🫶

bestie, that's the whole thing: rake 11.2.2, June 12, 2016, RAKE(1) 💅✨ periodt 🌈