Repository navigation
Home
divifetch is a build-time fetch script compiler.
instead of fetching system information on each run and dynamically assembling the output like the other fetch scripts, divifetch generates a C source file from a config, which you can compile into a standalone binary.
this approach allows for the resulting code to be mostly hard-coded at generation time. this also allows for the resulting binary to not have any runtime dependencies, to not waste time reading a config file at startup and to be as small as it should be.
config.conf -> generator -> fetch.c -> compiler (gcc) -> divifetch
- you create a config file
-
generator sourcereads the config and producesfetch.c - you compile
fetch.c
requires a C++ compiler (g++ or clang++).
g++ -o generator generator.cpp./generator [OPTIONS] SUBCOMMAND
| subcommand | description |
|---|---|
source |
read config.conf and write the fetch source to fetch.c
|
config |
generate an example config file (auto-detects OS, CPU, GPUs, mounts) |
| flag | long form | argument | description |
|---|---|---|---|
-h |
--help |
print help and exit | |
-c |
--config |
<file> |
config file to read (default: config.conf) |
-os |
--out-source |
<file> |
where to write the generated source (default: fetch.c) |
-oc |
--out-config |
<file> |
where to write the example config (default: config.conf.example) |
# generate, copy and edit the example config file:
./generator config
cp config.conf.example config.conf
vi config.conf
# generate the source and compile it
./generator source
gcc -O2 -static -s -o divifetch fetch.c
# run it
./divifetchconfigs use a simple s-expression syntax.
-
a form is
(name arg1 arg2 ...) -
comments start with
;and run to end of line -
string values are quoted with
" -
-and_can be interchangeably used in field names
there is one config form per file. it sets global defaults that apply to all entries.
(config
(art-width 45)
(art-file "ascii/cat.txt")
(art-prefix "\033[1m")
(art-suffix "\033[0m")
(key-prefix "\033[1m\033[34m")
(key-suffix "\033[0m: ")
(value-prefix "")
(value-suffix ""))| field | type | description |
|---|---|---|
art-width |
integer | column width reserved for the ascii art (including padding); prefixes and suffixes are not counted |
art-file |
string | path to a text file containing the ascii art (if missing or empty the art column is left blank) |
art-prefix |
string | escape sequence inserted before each art line |
art-suffix |
string | escape sequence inserted after each art line |
key-prefix |
string | default escape sequence before each entry's key |
key-suffix |
string | default text/sequence after each entry's key (e.g. : ) |
value-prefix |
string | default escape sequence before each entry's value |
value-suffix |
string | default text/sequence after each entry's value |
each entry occupies one line of output.
lines are paired with art lines from top to bottom.
if there are more entries than art lines the art column is padded with spaces.
values are known at generation time and baked into the binary.
| entry type | description |
|---|---|
static |
the standard key/value entry |
plain |
like static but with all prefixes and suffixes stripped. useful for decorative lines or headers |
break |
an empty line (no key, no value, no prefixes) |
colors_normal |
prints the 8 standard terminal palette colors as colored blocks |
colors_bright |
prints the 8 bright terminal palette colors as colored blocks |
values are resolved at runtime by calling a module function. the entry type must match a subdirectory name inside modules/.
if a module takes an argument (like mount), pass it as the second positional value or via the value field.
(mount "Mount (/)" "/")
; ^ ^
; key argumentevery entry (static or dynamic) accepts optional field overrides in named or positional form.
(static "OS" "Artix GNU/Linux")
; ^ ^
; key valuevalues are assigned in the following order:
key, value, key-prefix, key-suffix, value-prefix, value-suffix
use (field-name value) pairs inside the entry form
(static
(key "OS")
(value "Artix GNU/Linux"))positional arguments come first, named pairs after
(static "OS"
(value "Artix GNU/Linux"))| field | description |
|---|---|
key |
the label shown before the value; defaults to the entry type with a capitalised first letter |
value |
for static entries: the displayed value. for dynamic entries: optional argument passed to the module function |
key-prefix |
overrides the global key-prefix for this entry |
key-suffix |
overrides the global key-suffix for this entry |
value-prefix |
overrides the global value-prefix for this entry |
value-suffix |
overrides the global value-suffix for this entry |
strings in the config support ANSI escape sequences written as \033[...m.
for a reference on color and formatting codes see: https://jakob-bagterp.github.io/colorist-for-python/ansi-escape-codes/
common examples:
| code | effect |
|---|---|
\033[0m |
reset all formatting |
\033[1m |
bold |
\033[30m-\033[37m
|
foreground colors (black → white) |
\033[90m-\033[97m
|
bright foreground colors |
\033[38;2;R;G;Bm |
RGB foreground color |
a dynamic module lives in a subdirectory of modules/ and consists of two files:
modules/
\--- kernel/
|--- imports # list of needed headers
\--- module.c # source defining the module function
the generator reads only the modules that are actually referenced in your config, so unused ones produce no code in the output binary.
every module must export exactly one function following this convention:
// module without arguments
const char* kernel_module_preset(char* buf, size_t buf_size);
// module with an argument
const char* mount_module_preset(const char* arg, char* buf, size_t buf_size);the function writes its result into buf (256 bytes) and returns a pointer to it.
- create a directory
modules/$NAME/ - add an
importsfile listing any required C headers (one per line) - add a
module.cfile implementing$NAME_module_preset - use
$NAMEin your config
entry type names with hyphens are converted to underscores when generating the function name
when bindings for other programming languages are going to be added the format for the
importsfile listing will be changed
divifetch/
|--- generator.cpp # the generator source
|--- config.conf # your config file
|--- config.conf.example # generated example config
|--- fetch.c # generated fetch source (do not edit manually)
|--- ascii/
| \--- *.txt # ascii art files
\--- modules/
|--- kernel/
| |--- imports
| \--- module.c
|--- shell/
| |--- imports
| \--- module.c
\--- ... # one directory per dynamic module