ALR-CONFIG(1)

📦
version 1.2.1 · 2 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 ALR-CONFIG(1) — the alr config glow-up guide 💖

okay so this is a page from the Alire manual, and it's all about alr config — the little command that lets you list, get, set or unset your configuration options. bestie, it's giving "control panel but make it CLI" and honestly? iconic. 🎀

✨ NAME ✨

alr-config — List, Get, Set or Unset configuration options 🦋

✨ SYNOPSIS ✨

alr config [options] [--list] [--show-origin] [key_regex] | --get <key>
| --set <key> <value> | --unset <key>

like, that's the whole vibe. you pick a mode, you feed it a key, it does the thing. periodt. 💅

✨ OPTIONS ✨

  • --list — show me the configuration options, all of them, no crumbs left 🍓
  • --show-origin — when you're doing --list, also spill where each config value actually came from (no cap, receipts included) 🧚
  • --get — print out the value of one configuration option
  • --set — set a configuration option
  • --unset — unset a configuration option (bye bestie 👋)
  • --global — do your setting and unsetting on the global configuration instead of the local one 🌈
  • --builtins-doc — print a Markdown list of all the built-in configuration options 📝

✨ GLOBAL OPTIONS ✨

these ones are the everywhere-flags, the main character energy that applies across the board 👑

  • -c, --config=ARG — override where the configuration folder lives 📁
  • -f, --force — keep going even after a recoverable troublesome situation (bold. risky. slay.) 🔥
  • -h, --help — display general help, or help specific to a command
  • -n, --non-interactive — just assume the default answer for every single user prompt, no questions asked 🙈
  • --no-color — turns the colors off in output 🎨❌
  • --no-tty — disables control characters in output
  • --prefer-oldest — when resolving dependencies, prefer the oldest versions instead of the newest ones (yes, really, some of us love a vintage) 🕰️
  • --version — displays the version and then exits, immediately, goodbye
  • -q — limit output to errors only (quiet luxury 💜)
  • -v — be more verbose; use it twice for extra detail 🗣️
  • -d, --debug[] — enable debug-specific log messages 🐛

✨ DESCRIPTION ✨

so basically: alr config gives you a command line interface to the Alire configuration option files. that's the whole thing. 💖

Now let's talk about keys (option names), because there are rules and we respect them:

  • Option names (keys) can use lowercase and uppercase alphanumeric characters from the Latin alphabet.
  • Underscores and dashes can also be used — except as the first or last character. not at the edges, bestie, that's illegal 🚫
  • A dot . is used to specify sub-categories, e.g. 'user.name' or 'user.email'. the dot is the little bridge between them 🫶

And values? Option values can be:

  • integers
  • float
  • Boolean (true or false)
  • or strings

The type detection is automatic ✨ — e.g. 10 is integer, 10.1 is float, true is Boolean. and if you want to force a value to be set as a string, you wrap it in double-quotes, e.g. "10.1" or "true". lowkey genius.

Heads up: extra type checking is used for built-in options. so behave accordingly. 👀

Built-in configuration options:

🌸 index.auto_community [Boolean]

When unset (default) or true, the community index will be added automatically when required — but only if no other index is configured. 🏘️

🌸 user.name [String]

Your full name. Used for the authors and maintainers field of a new crate. put yourself in the credits, you earned it 👑

🌸 user.email [Email address]

Your email address. Used for the authors and maintainers field of a new crate. 📧

🌸 user.github_login [GitHub login]

Your GitHub login/username. Used for the maintainers-logins field of a new crate. 🐙

🌸 editor.cmd [String]

The editor command and arguments for editing crate code (alr edit). The executables and arguments are separated by a single space character. The token ${GPR_FILE} gets replaced by a path to the project file to open. 📝✨

🌸 msys2.do_not_install [Boolean]

If true, Alire will not try to automatically install the msys2 system package manager. (Windows only) 🪟

🌸 msys2.install_dir [Absolute path]

The directory where Alire will detect and/or install the msys2 system package manager. (Windows only) 🪟

🌸 msys2.installer [String]

The filename of the executable msys2 installer, e.g. 'msys2-x86_64-20220319.exe'. (Windows only) 🪟

🌸 msys2.installer_url [String]

The URL of the executable msys2 installer, e.g. 'https://github.com/msys2/msys2-installer/releases/download/2022-03-19/msys2-x86_64-20220319.exe'. (Windows only) 🪟

🌸 update-manually-only [Boolean]

If true, Alire will not attempt to update dependencies — not even after the manifest is manually edited, and not when no valid solution has ever been computed. All updates have to be manually requested through alr update. you're driving this car, bestie 🚗💨

🌸 distribution.disable_detection [Boolean]

If true, Alire will report an unknown distribution and will not attempt to use the system package manager. 🙈

🌸 solver.autonarrow [Boolean]

If true, alr with will replace 'any' dependencies with the appropriate caret/tilde dependency. 🎯

🌸 warning.caret [Boolean]

If true, Alire will warn about the use of caret (^) for pre-1 dependencies. ⚠️

🌸 warning.old_index [Boolean]

When unset (default) or true, a warning will be emitted when using a compatible index with a lower version than the newest known. 📢

🌸 toolchain.assistant [Boolean]

If true, an assistant to select the default toolchain will run when first needed. 🧰

✨ SEE ALSO ✨

alr(1), alr-printenv(1), alr-toolchain(1), alr-version(1), gprbuild(1) — go read those next, i'm obsessed with all of them fr fr 💖

✨ AUTHOR ✨

Generated with generate-man from Alire execution. 🤖

and that's the whole page, no notes!! 💅 this beauty came from Alire 1.2, dated Aug 3, 2022 — so yeah, it's got a little bit of a vintage timestamp but the energy is forever. bye bestie, go configure something 🦋✨

📦 where this page comes from