Skip to main content

Config Reference

Top-level config:

FieldTypeDescription
calendarslistCalendar definitions. At least one calendar is required.

Calendar fields:

FieldTypeDescription
namestringCalendar slug used in the feed URL.
publish_namestringCalendar name written to the output feed.
publicbooleanAllows access without a token.
tokenstringToken required for private calendar access.
token_filestringFile containing the access token.
feed_urlstringUpstream iCalendar URL.
feed_url_filestringFile containing the upstream iCalendar URL.
user_agentstringUser-Agent override for upstream requests.
filterslistOrdered filter definitions.

Filter fields:

FieldTypeDescription
descriptionstringHuman-readable filter description used in logs.
removebooleanRemoves matching events.
stopbooleanStops later filters after this filter matches.
matchobjectEvent match rules.
transformobjectEvent transform rules.

Match and transform rules currently support summary, description, location, and url.

Match target fields:

FieldTypeDescription
summaryobjectMatch against the event summary/title.
descriptionobjectMatch against the event description.
locationobjectMatch against the event location.
urlobjectMatch against the event URL.

String match conditions:

FieldTypeDescription
emptybooleanMatches when the property is absent or empty. When set, this condition is evaluated on its own.
containsstringMatches when the property contains this literal text.
contains_anylist of stringsMatches when the property contains at least one listed value. Empty list values are rejected.
contains_alllist of stringsMatches when the property contains every listed value. Empty list values are rejected.
prefixstringMatches when the property starts with this literal text.
suffixstringMatches when the property ends with this literal text.
regexstringMatches using a Go regular expression. Invalid regexes fail config compilation.

Transform target fields:

FieldTypeDescription
summaryobjectTransform the event summary/title.
descriptionobjectTransform the event description.
locationobjectTransform the event location.
urlobjectTransform the event URL.

String transform operations:

FieldTypeDescription
removebooleanSets the property to a blank string. This takes precedence over other transform operations.
replacestringReplaces the entire property value. This takes precedence over trim, text replacement, prefix, and suffix operations.
trim_prefixstringRemoves this text when the property starts with it.
trim_suffixstringRemoves this text when the property ends with it.
replace_textobjectReplaces literal text inside the property value.
prefixstringAdds text before the current property value.
suffixstringAdds text after the current property value.

replace_text fields:

FieldTypeDescription
oldstringLiteral text to replace. Required when replace_text is used.
newstringReplacement text.
allbooleanReplaces every occurrence when true; otherwise only the first occurrence is replaced.

When remove and replace are not set, string transforms run in this order: trim_prefix, trim_suffix, replace_text, prefix, suffix.