Rink’s configuration file uses the TOML format.
Duration types accept common suffixes like
ms, s,
h, d,
y. Size types accept suffixes like
MB.
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.
dim/dimmed
Uses a dimmed variant of the color instead of the bright
variant.
bold, italic, underline/under,
strikethrough
Formatting.
hidden/none
Makes the text invisible.
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.
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)
The [rink] section.
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
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.
Seting 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.
endpoint = <url>
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"
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.
theme = <string>
Sets the active theme. See the THEMES section. Default:
"default"
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"
