luarocks(1)

📦 version 3.8.0, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

✨ NAME ✨

okay so bestie, gather round — luarocks is your module deployment system for Lua 💖 like, it's the whole entire vibe for getting Lua libraries in and out of your life.

🌸 SYNOPSIS 🌸

luarocks [options] command

that's it. that's the whole ritual. options first, then the command. slay.

💅 DESCRIPTION 💅

LuaRocks is a module deployment system for Lua. periodt. it's the way you install, build, ship, and yeet Lua rocks around, and honestly? iconic.

ngl, there's one thing you need to know: variables from the "variables" table of the configuration file can be overridden with VAR=VALUE assignments. so like, you can just vibe in a value on the command line and it takes over. 💫

🎀 Options 🎀

  • --from=<server> — grab rocks/rockspecs from this server. heads up, this takes priority over the config file, so it's the main character here 👑
  • --only-from=<server> — fetch rocks/rockspecs from this server only. this one overrides any entries in the config file, like, it does not care what the config thinks 💀
  • --to=<tree> — which tree to operate on. as in, where the stuff goes. pick your tree bestie 🌳

🌈 Commands 🌈

  • build — Build/compile a rock. 🔨
  • download — Download a specific rock file from a rocks server. just the file, in your hands 🫴
  • help — Help on commands. because we all need a little help sometimes 😭
  • install — Install a rock. the classic. the moment. 💖
  • list — Lists currently installed rocks. inventory check bestie 📋
  • make — Compile package in current directory using a rockspec. yes, the current directory. right here, right now ✨
  • pack — Create a rock, packing sources or binaries. lil gift wrap situation 🎁
  • remove — Uninstall a rock. it's giving goodbye 💔
  • search — Query the LuaRocks servers. detective mode 🔍
  • unpack — Unpack the contents of a rock. open it up like a lil present 🍓
  • config — Query configuration. peek behind the curtain 🧚

🦋 SEE ALSO 🦋

luarocks-admin(1) — yes there's a whole other one, go look 👀

💜 FILES 💜

/etc/luarocks/config.lua

that's the config file. that's where the "variables" table lives. iykyk 🎀

⭐ AUTHOR ⭐

Enrico Tassi <gareuselesinge@debian.org> — thank you for your service, legend 🫶

okay so that's the whole page!! and just so you know where this came from — it's the LuaRocks manual, dated 10 November 2021, no cap. go forth and rock (literally) 🔥💅🌸

📦 where this page comes from