Deadline CLI Reference

deadline config

View and update Deadline's workstation configuration, including the default AWS profile, farm, queue, and other settings.

Most settings depend on the selected AWS profile, so you can store different configurations per profile and switch between them.

Usage:

deadline config [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

clear

Clears a workstation configuration setting to restore its default value.

Example: deadline config clear defaults.farm_id

Usage:

deadline config clear [OPTIONS] SETTING_NAME

Options:

  --help  Show this message and exit.

get

Prints the value of a workstation configuration setting.

Useful for scripting with the AWS CLI, for example:

aws deadline get-queue \
  --profile $(deadline config get defaults.aws_profile_name) \
  --farm-id $(deadline config get defaults.farm_id) \
  --queue-id $(deadline config get defaults.queue_id)

Usage:

deadline config get [OPTIONS] SETTING_NAME

Options:

  --help  Show this message and exit.

gui

Open the workstation configuration settings GUI to view or edit setting values.

Usage:

deadline config gui [OPTIONS]

Options:

  --install-gui  Installs GUI dependencies if they are not installed already
  --help         Show this message and exit.

set

Sets a workstation configuration setting.

Example: deadline config set defaults.farm_id <farm-id>

Usage:

deadline config set [OPTIONS] SETTING_NAME VALUE

Options:

  --help  Show this message and exit.

show

Show all workstation configuration settings and current values.

Usage:

deadline config show [OPTIONS]

Options:

  --output [verbose|json]  Output format of the command
  --help                   Show this message and exit.