Configuration

Unless specified otherwise, Anzeiger attempts to load it’s configuration from anzeiger.yaml in your cwd (Current Working Directory, the directory you ran bunx anzeiger in).

If no configuration file was found, Anzeiger offers to guide you through a small onboarding, in which it generates the file.

You can specify the config file Anzeiger should load by passing -c or --config, respectively:

 # Relative path: Anzeiger attempts to load `./anzeiger.prod.yaml`
bunx anzeiger -- -c anzeiger.prod.yaml

# Absolute paths work also
bunx anzeiger -- -c /var/anzeiger/anzeiger.monitoring.yaml

Minimum required configuration

The config file Anzeiger generates throughout the onboarding process basically resembles the minimum required configuration:

theme: fallout
plugins:
  []
pluginConfigs:
  {}

Example configuration file

The following configuration will instruct Anzeiger to use the ultraviolet theme and load @anzeiger/now (via plugins:).

It also provides configuration (latitude and longitude) for @anzeiger/now.

theme: ultraviolet
plugins:
    - "@anzeiger/now"
pluginConfigs:
    "@anzeiger/now":
        longitude: 7.8944
        latitude: 49.9675456
console:
    enabled: false

Reference

Main configuration

Key	Description	Default
theme	Choose a color palette Anzeiger will use. Supported values: fallout | acai | idk | ultraviolet	fallout
plugins	An array of enabled plugin names. Plugins need to be installed via npm/bun, so that they’re available for Anzeiger to load during runtime.	[]
pluginConfigs	A record with configurations for plugins. Use the plugin’s name (e.g. @anzeiger/now) as key.	{}
console	see console	undefined

Console

Key	Description	Default
enabled	Controls whether or not the console will be displayed	false
logLevel	Set the loglevel. Possible values: ‘verbose’, ‘info’, ‘warning’, ‘error'	'info’

Plugin configuration

The respective’s plugin configuration schema belong to the plugins only.

I plan to enable plugins to register their configuration schema (via Zod), so that Anzeiger can validate a plugin’s configuration on startup.