Reference

Command-line options

grydgets [--widgets FILE] [--theme FILE] [--config-dir DIR]

• --widgets: Widget configuration file. Defaults to widgets.yaml.
• --theme: A theme file to use instead of the widgets file's own theme: block. Using this turns off day/night switching if conf.yaml configures it.
• --config-dir: Directory containing config files, fonts, and images. All relative paths are resolved from here. Defaults to the current working directory.

grydgets-client shows a dashboard that's rendered on another machine (see Remote displays), and grydgets-editor starts the widget editor.

HTTP endpoints

The server is only started if at least one of these features is in use. See server.

Endpoint	What uses it
/notify	Push widgets
/frame, /events	The stream output
/theme	appearance.http_control: true

Signals

• SIGUSR1: reload conf.yaml, widgets.yaml, providers.yaml and the theme files.

schema.json

schema.json in the repository root is a JSON Schema for widgets.yaml. If you point your editor at it, you'll get completion and validation for every widget and parameter while you type. With the YAML language server (used by VS Code's YAML extension, among others), add this line at the top of widgets.yaml:

# yaml-language-server: $schema=./schema.json