Documentationbreadcrumb arrow Grafana Alloybreadcrumb arrow Referencebreadcrumb arrow Command-line interface
Open source

The Grafana Alloy 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 Alloy.

Available commands:

  • convert: Convert an Alloy configuration file.
  • fmt: Format an Alloy configuration file.
  • gql: Run a GraphQL query against a running Alloy instance.
  • run: Start Alloy with the Default Engine, given an Alloy syntax configuration file.
  • otel: Start Alloy with the experimental OTel Engine, given an OpenTelemetry Collector YAML configuration file.
  • tools: Read the WAL and provide statistical information.
  • validate: Validate an Alloy configuration file or directory path.
  • completion: Generate shell completion for the alloy CLI.
  • help: Print help for supported commands.