Repository navigation
configuration
Onefetch can read its options from a config file, so you don't have to type them every time.
Onefetch reads ~/.config/onefetch/config.jsonc, or $XDG_CONFIG_HOME/onefetch/config.jsonc if XDG_CONFIG_HOME is set. This is the same on Linux, macOS and Windows. Nothing happens if the file doesn't exist.
To use another file, pass --config <PATH>.
The file is a JSON object whose keys are the command-line options, written with their long name and without the leading --. Comments (// and /* */) and trailing commas are allowed.
Values work like on the command line:
| Option | Value | Example |
|---|---|---|
A flag, like --no-merges
|
true or false
|
"no-merges": true |
An option with one value, like --number-of-authors <NUM>
|
a number or a string | "number-of-authors": 5 |
An option with several values, like --exclude <EXCLUDE>...
|
a list | "exclude": ["*.lock"] |
The input directory, --config, --languages, --package-managers and --generate can only be given on the command line.
presets/cowsay.jsonc uses every option, with a cowsay cow as the logo. Try it with onefetch --config presets/cowsay.jsonc, or copy it to ~/.config/onefetch/config.jsonc and keep the options you want.
An option given on the command line replaces the same option in the file. With "number-of-authors": 5 in the config, onefetch --number-of-authors 2 shows 2 authors. This holds for lists too: with "exclude": ["*.lock"] in the config, onefetch -e "*.md" excludes only *.md.
A flag turned on in the file can't be turned off from the command line, and a value set in the file, like "output" or "image", can't be removed. To run onefetch without the config, point --config at an empty file.
{ // Show 5 authors instead of 3 "number-of-authors": 5, "ignore-author": "^bors$", "no-merges": true, "exclude": ["*.lock", "vendor/"], "disabled-fields": ["churn", "url"], "text-colors": [9, 10, 11, 12, 13, 14], "number-separator": "comma", "nerd-fonts": true }