User Config Reference

Overview

Guild user configuration is defined in ~/.guild/config.yml. User configuration applies across all projects and packages.

Note A future version of Guild will support project-level user configuration. This can be used to associate user config, including remotes, with a project.

Check

Section heading: check

guild check can be configured by defining any of the attributes below under a top-level check mapping.

Check Attributes

offline

Flag specifying default offline mode for checks (boolean)

When offline, Guild will not check for latest versions and will instead show unchecked (offline).

Default is no.

Check Examples

Don’t check for latest Guild AI version by default:

check:
  offline: yes

Note, you can use --offline or --no-offline when running guild check to override this setting.

Diff

Section heading: diff

guild diff can be configured by defining any of the attributes below under a top-level diff mapping.

Diff Attributes

command

Command used when diffing two paths (string)

Two paths are appended to this command as separate arguments — one for each applicable run path.

Diff Examples

Use Meld to diff runs:

diff:
  command: meld

Remotes

Section heading: remotes

Remotes provide configuration that Guild uses for remote-related operations. A remote operation is specified by using the --remote option with the name of remote configured in this section.

For example, the following command starts an operation on a remote named my-host:

guild run train --remote my-host

In this case, my-host must be defined under remotes in user config:

remotes:
  my-host:
    ...

Refer to Remotes Reference for details on configuring remote types.