Skip to content

Latest commit

 

History

History
29 lines (23 loc) · 1.2 KB

_index.md

File metadata and controls

29 lines (23 loc) · 1.2 KB
canonical description menuTitle title weight
Learn about the Grafana Alloy command line interface
Command-line interface
The Grafana Alloy command-line interface
50

The {{% param "FULL_PRODUCT_NAME" %}} command-line interface

The alloy binary exposes a command-line interface with subcommands to perform various operations.

The most common subcommand is run which accepts a configuration file and starts {{< param "PRODUCT_NAME" >}}.

Available commands:

  • convert: Convert an {{< param "PRODUCT_NAME" >}} configuration file.
  • fmt: Format an {{< param "PRODUCT_NAME" >}} configuration file.
  • run: Start {{< param "PRODUCT_NAME" >}} with the Default Engine, given an Alloy syntax configuration file.
  • otel: Start {{< param "PRODUCT_NAME" >}} with the experimental OTel Engine, given an Open Telemetry Collector YAML configuration file.
  • tools: Read the WAL and provide statistical information.
  • completion: Generate shell completion for the alloy CLI.
  • help: Print help for supported commands.