lux-cli-build(1)

📦 version 0.48.0, in nixpkgs unstable

💅 lux-cli-build — build/compile a project, bestie! 💅

Okay so literally, this is the lux-cli-build(1) manual page, and it's about to teach you how to build a project like the main character you are. No cap, this is the whole thing, every flag, every vibe. Let's get into it. ✨

🌸 NAME 🌸

lux-cli-build — Build/compile a project. That's it. That's the whole job. Slay. 🔥

✨ SYNOPSIS ✨

lux-cli build [--no-lock] [--only-deps] [--server] [--extra-servers]
[-p|--package] [--namespace] [--lua-dir] [--lua-version] [--tree]
[--cache-dir] [--data-dir] [--variables] [--profile] [--verbose]
[--no-progress] [--no-prompt] [--preset] [--nvim] [--no-tfa] [--timeout]
[--max-jobs] [--no-luarc] [--no-wrap-bin] [--user-agent] [-h|--help]

Like, that's the whole command. You just type lux-cli build and then add whatever flags your heart desires. It's giving "choose your own adventure" but for compiling. 🦋

🎀 DESCRIPTION 🎀

Build/compile a project. Lowkey the most important thing this tool does. You have a project? You want it built? This is the command. Periodt. 💖

👑 OPTIONS 👑

Okay bestie, here's where it gets juicy. Every single flag, explained with love. 🫶

  • --no-lock — Ignore the project's lockfile and don't create one. Like, forget the lockfile exists. It's not invited to the party. 🙈
  • --only-deps — Build only the dependencies. Not your project itself. Just the friends it needs to function. 🍓
  • --server <server> — Fetch rocks/rockspecs from this server. Takes priority over the config file. Like, this server is the VIP, okay? It gets first dibs. 🌟
  • --extra-servers <extra-server> — Fetch rocks/rockspecs from these servers in addition to the main server{n}. This overrides any entries in the config file. So you're like, "I want these servers too, actually." The more the merrier. 🌈
  • -p, --package <PACKAGE> — Package to build. Which one? This one. You point at it. It builds. Iconic. 🎯
  • --namespace <namespace> — Specify the luarocks server namespace to use. It's giving "hello, I'd like to speak to the manager" but for server namespaces. 💅
  • --lua-dir <prefix> — Specify the directory in which to install Lua if not found. Like, "Lua's not here? Check this folder, bestie." 📁
  • --lua-version <ver> — Which Lua installation to use.{n} Valid versions are: '5.1', '5.2', '5.3', '5.4', '5.5', 'jit' and 'jit52'.{n} If not set, Lux will attempt to detect the Lua version:{n} - From the current project, if it has an exact Lua version requirement.{n} - From the Lua installation that is available on the PATH. So many choices! Pick your fighter. 🥊
  • --tree <tree> — Which tree to operate on.{n} In a workspace, this can be used to specify a detached workspace tree. Like, this tree is not like the other trees. It's detached. Main character tree energy. 🌳
  • --cache-dir <cache-dir> — Specifies the cache directory, e.g. for luarocks manifests. Cache queen behavior. 💾
  • --data-dir <data-dir> — Specifies the data directory,{n} in which the default user install tree resides{n} (e.g. ~/.local/share/lux). This is where the data lives. Home sweet home. 🏠
  • --variables <variable> — Override config variables.{n} Example: lx -v "LUA=/path/to/lua" .... Like, you're the boss of the variables now. 🔧
  • --profile <profile> — The build profile to use when compiling packages.{n} Default: release. Possible values: release, dev. Release is the default because we're fancy, but dev is there if you're in your experimental era. 🧪
  • --verbose — Display verbose output of commands executed, enabling DEBUG logs.{n} To enable TRACE logs, set RUST_LOG=trace. It's giving "tell me everything, I want all the tea." ☕
  • --no-progress — Don't print any progress bars or spinners. For when you want a calm, quiet, minimal vibe. No spinning, no stress. 🧘‍♀️
  • --no-prompt <NO_PROMPT> — Skip prompts, selecting the default option.{n} Prompting is enabled by default in terminal/TTY environments. Possible values: true, false. You can just say "yes, do the default thing, I trust you." 🫡
  • --preset <preset> — Configure Lux for a specific environment.{n} Valid presets are: 'nvim'. Possible values: nvim: Configure Lux for Neovim plugins. It's giving "I know exactly what you are." 💅
  • --nvim — [DEPRECATED] Configure lux for installing Neovim packages.{n} Use --preset nvim instead. > ⚠️ Warning: This is deprecated, bestie! Use --preset nvim instead. Don't use the old thing when the new thing is right there. 💀
  • --no-tfa — Disable prompts for two-factor authentication (2FA) codes.{n} It is strongly recommended to enable 2FA instead see (https://luarocks.org/settings/two-factor-auth). > ⚠️ Warning: Like, please enable 2FA instead. It's for your own good. Security is sexy. 🔐
  • --timeout <seconds> — Timeout on network operations, in seconds.{n} 0 means no timeout (wait forever). Default is 30. Thirty seconds is the vibe, but you can wait forever if you want to. Your call. ⏳
  • --max-jobs <MAX_JOBS> — Maximum buffer size for parallel jobs, such as downloading rockspecs and installing rocks. 0 means no limit. Default is 0. So like, no limits, bestie. Go off. 🚀
  • --no-luarc — Do not generate or update a .luarc.json file when building{n} a project. We're not touching the luarc today. Hands off. 🙅‍♀️
  • --no-wrap-bin — Do not wrap Lua bin scripts. No wrapping. Just raw. ✨
  • --user-agent <USER_AGENT> — The user agent to set when making web requests. Default is "lux/<version>". You can be anyone you want on the internet. Identity is a construct. 🌈
  • -h, --help — Print help (see a summary with -h). Like, this page but shorter. The TL;DR. 📖

💖 SIGN-OFF 💖

Okay that's literally it! You made it to the end, bestie! You're now a lux-cli build expert. Go forth and compile things like the icon you are. No cap, you're gonna slay. 💅✨

Catch u later! 💜 This page was brought to you by the build command from the lux-cli-build(1) manual, version whatever-the-version-is, with all the love and none of the boring manpage vibes. 🎀🦋

📦 where this page comes from