Skip to content

Commit

Permalink
Add some clarification about config resolution order
Browse files Browse the repository at this point in the history
  • Loading branch information
plars committed Jan 6, 2025
1 parent 7cd7fe0 commit 35cd294
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/reference/cli-config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ The Testflinger CLI can be configured on the command line using the parameters d

The configuration file is read from ``$XDG_CONFIG_HOME/testflinger-cli.conf`` by default, but this can be overridden with the ``--configfile`` parameter.

When a configuration variable is defined in multiple locations, Testflinger resolves the value by applying the following priority order, from highest to lowest:

1. command-line parameter (for example, ``--server <local_server>``)

2. configuration file

3. environment variable

You can show the current values stored in the config file by running ``testflinger config``. If no value is found on the command line, config file, or environment variable, then a safe default value will be used.

To set a configuration value in the config file, you can edit it directly or use ``testflinger config key=value``.
Expand Down

0 comments on commit 35cd294

Please sign in to comment.