Caution
Grafana Alloy is the new name for our distribution of the OTel collector. Grafana Agent has been deprecated and is in Long-Term Support (LTS) through October 31, 2025. Grafana Agent will reach an End-of-Life (EOL) on November 1, 2025. Read more about why we recommend migrating to Grafana Alloy.
Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
grafana-agent fmt command
The grafana-agent fmt command formats a given Grafana Agent Flow configuration file.
Usage
Usage: grafana-agent fmt [FLAG ...] FILE_NAME
If the FILE_NAME argument is not provided or if the FILE_NAME argument is
equal to -, grafana-agent fmt formats the contents of standard input. Otherwise,
grafana-agent fmt reads and formats the file from disk specified by the argument.
The --write flag can be specified to replace the contents of the original
file on disk with the formatted results. --write can only be provided when
grafana-agent fmt is not reading from standard input.
The command fails if the file being formatted has syntatically incorrect River configuration, but does not validate whether Flow components are configured properly.
The following flags are supported:
--write,-w: Write the formatted file back to disk when not reading from standard input.
Was this page helpful?
Related resources from Grafana Labs
