Configuration

rscalendar supports an optional TOML config file for setting defaults.

File Location

~/.config/rscalendar/config.toml

The config file is optional. If missing, built-in defaults are used. All config values can be overridden by CLI flags.

Options

The [check] Section

The [check] section defines required properties per event type. It is used by the rscalendar check command to validate that events have all expected properties.

[check]
teaching = ["client", "company", "course"]
working = ["client", "company"]
call = ["client", "company"]
meeting = ["client", "company"]

Each key is a type property value; its array lists the property keys that must be present on events of that type.

Example

# Use a specific calendar by default
calendar_name = "Teaching"

# Always print URL instead of opening browser (headless machines)
no_browser = true

# Required properties per event type
[check]
teaching = ["client", "company", "course"]
working = ["client", "company"]

Precedence

CLI flags always win over config file values:

# Uses calendar_name from config.toml
rscalendar list

# Overrides config.toml with the flag value
rscalendar list --calendar-name "Work"

Files Overview