RINK(5)

πŸ“¦
version 0.9.0 Β· 3 versions
, in arch rolling

πŸ’– RINK(5) β€” the rink manual, config edition πŸ’–

okay bestie, so this is RINK(5) from the Rink Manual β€” it's the page that explains Rink's config file, and honestly? it ate. let's get into it 🫢


✨ NAME ✨

rink β€” the TOML configuration file format. that's it, that's the vibe. πŸ’…


🌸 DESCRIPTION 🌸

Rink's configuration file uses the TOML format. no cap, that's the whole format reveal.

Duration types accept common suffixes like ms, s, h, d, y. Size types accept suffixes like MB. so you can be all "hours" and "megabytes" about it, iconic.

Color strings are a set of keywords separated by spaces. The following keywords are understood:

  • black, red, green, yellow, blue, purple, cyan, white, dark_gray, light_red, light_green, light_yellow, light_blue, light_purple, magenta, light_magenta, light_cyan, light_gray β€” sets the color to that ANSI color. the classics, the main characters πŸ‘‘
  • dim / dimmed β€” uses a dimmed variant of the color instead of the bright variant.
  • bold, italic, underline / under, strikethrough β€” formatting. yes, you can be dramatic in a terminal.
  • hidden / none β€” makes the text invisible. spooky. it's giving ghost text πŸ‘»
  • on β€” the color keyword after this will apply to the background instead of the foreground. Example: black on red.
  • default / plain β€” results in unstyled text. the "no thoughts, head empty" option.
  • integers 0 to 255 β€” extended terminal color palette codes.
  • # <6 hex letters> β€” hex codes can be used to specify truecolor. Example: #000000
  • rgb( <red> , <green> , <blue> ) β€” RGB values can be used to specify truecolor. No spaces are allowed. Example: rgb(10,10,10)

πŸ’… Rink

The [rink] section. yes it's named after itself, main character energy.

  • prompt = <string> β€” the text that will be displayed before the cursor, to hint interactivity. Should include the space character. Default: "> "
  • long_output = <bool> β€” breaks lists, such as search results, over multiple lines. Requires a Unicode-capable terminal. Default: false
  • show_interpretation = <bool> β€” shows the input query reformatted based on how Rink interpreted it. Supports syntax highlighting. Default: true

πŸ’° Currency

The [currency] section.

  • enabled = <bool> β€” currency support can be disabled entirely. When set to false, the currency.json will not be loaded, and trying to use currency units will give a "not found" error. Default: true
  • behavior = <"prompt" | "always"> β€” Default: "prompt". When attempting to use a currency unit, Rink will ask if you'd like to download the currency data. Setting it to "always" will download immediately when a currency unit is used.
  • cache_expiration_enabled = <bool> β€” Default: true. Setting this to false causes rink to behave as if cache_duration was infinite. If the currency file doesn't exist, it will fetch it, otherwise it will use it indefinitely. Rink can be invoked with --fetch-currency to download the latest version. This setting might be useful for intermittent internet access β€” you can setup a cron job to fetch the currency data while the network is up, making it available later when using rink offline. lowkey genius for offline girlies 🧚
  • endpoint = <url> β€” allows pointing to alternate Rink-Web instances, or to any other API that offers a compatible format. Default: "https://rinkcalc.app/data/currency.json"
  • timeout = <duration> β€” how long to wait for currency fetching before giving up. Default: "15s"
  • cache_duration = <duration> β€” how long to wait before considering the cached currency data stale. Default: "1h"

🌈 Colors

The [colors] section.

  • enabled = <bool> β€” set to true to turn on colored output. Default: true, or false if the NO_COLOR environment variable is set. (yes, env var said "not today" and wins, periodt)
  • theme = <string> β€” sets the active theme. See the THEMES section. Default: "default"

🎨 Themes

The [themes] section. This section is a dictionary, each theme should be created as [themes.my_theme]. These options are specific to each.

  • plain = <color> β€” generic text. This will be used often. Default: "default"
  • error = <color> β€” error messages. Default: "red"
  • unit = <color> β€” the names of units, like kilogram. Default: "cyan"
  • quantity = <color> β€” the names of physical quantities, like length and time. These are shown in parentheses on every query. Default: "dimmed cyan"
  • number = <color> β€” numbers that appear in outputs. Default: "default"
  • user_input = <color> β€” used when rink is quoting user input back, such as in unit not found errors. Default: "bold"
  • doc_string = <color> β€” used when rink is showing informational text that's part of the definition of a unit, like meter. Default: "italic"
  • pow = <color> β€” the ^2 in m/s^2. Default: "default"
  • prop_name = <color> β€” names of properties in substances, like the speed in speed of light. Default: "cyan"
  • date_time = <color> β€” date time objects, that can be obtained with the hash notation or now. Default: "default"
  • link = <color> β€” a hyperlink, typically found inside of doc strings. Default: "cyan"
  • keyword = <color> β€” special words in Rink's query language, like of, digits, etc. Default: "yellow"
  • timezone = <color> β€” timezones, like [US/Pacific]. Default: "cyan" πŸ¦‹

πŸ“ FILES πŸ“

where the config lives, depending on your OS bestie:

  • Linux β€” __$XDG_CONFIG_DIR__/rink/config.toml
  • Windows β€” __{FOLDERID_RoamingAppData}__\rink\config.toml
  • macOS β€” __$HOME__/Library/Application Support/rink/config.toml

πŸ¦‹ SEE ALSO πŸ¦‹

rink(1), rink(7), rink-defs(5), rink-dates(5) β€” go read the whole set, iykyk πŸ’œ


that's the whole page, bestie β€” no notes. this was the Rink Manual, version dated 2026-08-30, filed under RINK(5). love u, go configure something iconic πŸ’…βœ¨

πŸ“¦ where this page comes from
  • arch rolling: rink 0.9.0-1 Β· GPL-3.0-or-later AND MPL-2.0
  • πŸ’– girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms