sofmani/docs/configuration-reference.md

Configuration Reference

Here is a breakdown of all configuration options:

Global Options

• install (Array)

  • Installation steps to execute.

  • See Installer Configuration for supported types and options that you can provide.

• debug (Boolean)

  • Enable or disable debug mode.
  • Default: false.

• check_updates (Boolean)

  • Enable or disable checking for updates before running operations.
  • Default: false.

• summary (Boolean)

  • Enable or disable the installation summary at the end.
  • The summary shows newly installed and upgraded software in a hierarchical format.
  • Default: true.

• defaults (Object)

  • Defaults to apply to all installer types, such as specifying supported platforms or commonly used flags.

  • defaults.type

    A mapping between each type (key) and their default options (value).

    • See Installer Configuration for supported types and options that you can override.

• env (Object)

  • Environment variables that will be set for the context of the installer.
  • OS environment variables are passed and may be overridden for this config and all of its installers here.

• machine_aliases (Object)

  • A mapping of friendly names to machine IDs.
  • Use sofmani --machine-id to get the machine ID for each of your machines.
  • These aliases can then be used in installer machines.only and machines.except fields instead of the raw machine IDs.
  • Example:

    machine_aliases:
      work-laptop: 5fa2a8e8193868df
      home-desktop: a1b2c3d4e5f67890
      home-server: fedcba0987654321
    

Example Config

debug: false
check_updates: true
summary: true
defaults:
  type:
    brew:
      platforms:
        only: ['macos']
install:
  - name: jq
    type: brew