Configuration

Both the CLI and the web application can be configured from a TOML file.

Note

Configuration file loading dependencies get installed automatically when installing the CLI or the web application extras.

The configuration file path can be specified either through the --config CLI option or through the READER_CONFIG environment variable (also usable with the web application).

The configuration file matches the shape of the CLI (the reader section has options for the reader command, the reader.update section has options for the reader update command, etc.). In general, option names match those in the CLI (--feed-root -> feed_root); options that can be passed multiple times in the CLI are pluralized in the config (--cli-plugin -> cli_plugins).

Example:

# The config file consists of default values for CLI options.

# Global options go in the [reader] section.

[reader]
url = "/path/to/db.sqlite"
feed_root = "/path/to/feeds"
# Options that can be passed multiple times take a list of values
# (unlike other settings, plugins are merged with commandline options).
plugins = [
    "reader._plugins.sqlite_releases",
    ".ua_fallback",
]

# Subcommand defaults go in nested tables.

# add --update
[reader.add]
# Flags take a boolean value.
update = true

# update --workers 10 -vv
[reader.update]
workers = 10
# Flags that can be repeated take an integer.
verbose = 2