lux-cli-sync(1)

📦 version 0.48.0, in nixpkgs unstable

🦋 lux-cli-sync(1) — General Commands Manual, but make it group-chat 🦋

💖 NAME 💖

lux-cli-sync — Synchronize the project tree with the current lux.toml,{n} ensuring all packages are installed correctly. Bestie, this is the “make it match and make it installed” button. 💅

✨ SYNOPSIS ✨

lux-cli sync [--no-integrity-check] [--server] [--extra-servers]
       [--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]

🎀 DESCRIPTION 🎀

Synchronize the project tree with the current lux.toml,{n} ensuring all packages are installed correctly. Translation: get your tree matching the current lockfile-ish situation and make sure every package is actually installed right, no fake vibes. 🫶

🌸 OPTIONS 🌸

  • --no-integrity-check — Skip the integrity checks for installed rocks when syncing the project lockfile. Living dangerously, but make it explicit. 👀
  • --server <server> — Fetch rocks/rockspecs from this server (takes priority over config file). This one gets main-character priority. 👑
  • --extra-servers <extra-server> — Fetch rocks/rockspecs from these servers in addition to the main server{n} (overrides any entries in the config file). Extra servers, extra sparkle. ✨
  • --namespace <namespace> — Specify the luarocks server namespace to use. 🦋
  • --lua-dir <prefix> — Specify the directory in which to install Lua if not found. Like putting Lua’s house exactly where you want it. 🏠
  • --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. 📌
    • From the Lua installation that is available on the PATH. 🌈
  • --tree <tree> — Which tree to operate on.{n} In a workspace, this can be used to specify a detached workspace tree. Tree choice = whole vibe choice. 🌳
  • --cache-dir <cache-dir> — Specifies the cache directory, e.g. for luarocks manifests. 🍓
  • --data-dir <data-dir> — Specifies the data directory,{n} in which the default user install tree resides{n} (e.g. ~/.local/share/lux). Home sweet data home. 🏡
  • --variables <variable> — Override config variables.{n} Example: lx -v "LUA=/path/to/lua" ... 💜
  • --profile <profile> — The build profile to use when compiling packages.{n} Default: release.

Possible values:

  • release
  • dev
  • --verbose — Display verbose output of commands executed, enabling DEBUG logs.{n} To enable TRACE logs, set RUST_LOG=trace. Turn the volume up on the logs, bestie. 🔊
  • --no-progress — Don’t print any progress bars or spinners. No little animations, just quiet slay. 🤫
  • --no-prompt <NO_PROMPT> — Skip prompts, selecting the default option.{n} Prompting is enabled by default in terminal/TTY environments.

Possible values:

  • true
  • false
  • --preset <preset> — Configure Lux for a specific environment.{n} Valid presets are: 'nvim'.

Possible values:

  • nvim: Configure Lux for Neovim plugins 🧚
  • --nvim — [DEPRECATED] Configure lux for installing Neovim packages.{n} Use --preset nvim instead. Iconic but retired, okay? 💀
  • --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). Security warning with a bow on it: please use 2FA. 🔐
  • --timeout <seconds> — Timeout on network operations, in seconds.{n} 0 means no timeout (wait forever). Default is 30. ⏳
  • --max-jobs <MAX_JOBS> — Maximum buffer size for parallel jobs, such as downloading rockspecs and installing rocks. 0 means no limit. Default is 0. Parallel go brrr, but with a limit if you want. 🔥
  • --no-luarc — Do not generate or update a .luarc.json file when building{n} a project. 🎀
  • --no-wrap-bin — Do not wrap Lua bin scripts. Leave those bin scripts unwrapped, fr fr. 🫶
  • --user-agent <USER_AGENT> — The user agent to set when making web requests. Default is "lux/<version>". 🌐
  • -h, --help — Print help (see a summary with '-h'). Help is always a valid accessory. 💅

okay that’s the whole page, bestie 🫶 this lux-cli-sync(1) page is from the General Commands Manual, footer source/version is sync, and the date isn’t listed in the footer — so we’re signing off with vibes and receipts only 💖✨

📦 where this page comes from