Agent command line options

The redirection.io agent supports several command line options:

/usr/bin/redirectionio-agent --help

redirection.io Agent and Proxy Application

The agent is responsible for managing the communication between your application and redirection.io services. It handles your rules and collects logs about the requests processed by your application.

It can either run as a standalone agent or as a reverse proxy in front of your application.

Usage: redirectionio-agent [OPTIONS]

Options:
  -d, --debug
          Turn debugging information on

-t, --test
          Test config file and exit, return number of errors as exit code

-c, --config <CONFIG>
          Path to configuration file, if not provided default paths will be used

--pid <PID>
          PID of the existing agent to signal for reload

--socket <SOCKET>
          Path to the socket to use for reload, if not provided no reload will be done

-h, --help
          Print help (see a summary with '-h')

-V, --version
          Print version

Start-defined configuration file [Permalink to this section](/content/documentation/agent-documentation/agent-command-line-options#start-defined-configuration-file "Permalink to this section"/index.html)

By default, the agent will start using a /etc/redirectionio/agent.yml or $HOME/.redirectionio/agent.yml configuration file. If required, you can also pass the --config option to force a given configuration file:

/usr/bin/redirectionio-agent --config /path/to/some/configuration/directory/some-config-file.yml

Debug level [Permalink to this section](/content/documentation/agent-documentation/agent-command-line-options#debug-level "Permalink to this section"/index.html)

The --debug option gives more details on how the agent behaves. You may use it to troubleshoot your redirection.io agent install:

/usr/bin/redirectionio-agent --debug

Configuration test [Permalink to this section](/content/documentation/agent-documentation/agent-command-line-options#configuration-test "Permalink to this section"/index.html)

The --test option allows to test the configuration file and get insights on mis-configurations. This command returns a non-zero code when the agent is not properly configured, so you may use it in provisioning scripts to only restart/reload the agent when the configuration is properly defined.

/usr/bin/redirectionio-agent --test

2025-09-26T15:48:53.381109Z WARN config key 'loggg' does not exist, is it a typo?

Get the current agent version [Permalink to this section](/content/documentation/agent-documentation/agent-command-line-options#get-the-current-agent-version "Permalink to this section"/index.html)

The --version option displays the release name of the installed redirection.io agent:

/usr/bin/redirectionio-agent --version

redirectionio-agent 3.0.0