config.yaml

The following settings are configurable in the config file like so:

yaml

config.yaml

dotfiles: <path to dotfiles>
link_type: <'symbolic'|'hard'>
shell_command: <shell command template used for the install command>
variables: <map of variables which can be used in templates>

toml

config.toml

dotfiles = '<path to dotfiles>'
link_type = "<'symbolic'|'hard'>"
shell_command = '<shell command template used for the install command>'
variables = '<map of variables which can be used in templates>'

json

config.json

{
  "dotfiles": "<path to dotfiles>",
  "link_type": "<'symbolic'|'hard'>",
  "shell_command": "<shell command template used for the install command>",
  "variables": "<map of variables which can be used in templates>"
}

Those settings can be overridden in the cli when applicable (see rotz --help and rotz <command> --help to get more information).

shell_command

This setting allows to specify how Rotz should launch the install command.

If this is not set the default values are used.

yaml

Windows

shell_command: powershell -NoProfile -C {{ quote "" cmd }}

toml

Windows

shell_command = 'powershell -NoProfile -C {{ quote "" cmd }}'

json

Windows

{
  "shell_command": "powershell -NoProfile -C {{ quote \"\" cmd }}"
}

yaml

Linux

shell_command: bash -c {{ quote "" cmd }}

toml

Linux

shell_command = 'bash -c {{ quote "" cmd }}'

json

Linux

{
  "shell_command": "bash -c {{ quote \"\" cmd }}"
}

yaml

MacOS

shell_command: zsh -c {{ quote "" cmd }}

toml

MacOS

shell_command = 'zsh -c {{ quote "" cmd }}'

json

MacOS

{
  "shell_command": "zsh -c {{ quote \"\" cmd }}"
}

variables

These variables can be used in templates.

yaml

config.yaml

variables:
  some: value
  array:
    - one
    - two

toml

config.toml

[variables]

some = 'value'
array = [
  'one',
  'two',
]

json

config.json

{
  "variables": {
    "some": "value",
    "array": [
      "one",
      "two"
    ]
  }
}

Repo defaults

It is possible to put a config file in your repo containing default values depending on the OS. These are overridden by the config file on the machine.

yaml

.dotfiles/config.yaml

global:
  link_type: <globalDefault>
windows:
  dotfiles: <windowsDefault>
linux:
  dotfiles: <linuxDefault>
darwin:
  dotfiles: <macosDefault>

toml

.dotfiles/config.toml

[global]

link_type = '<globalDefault>'

[windows]

dotfiles = '<windowsDefault>'

[linux]

dotfiles = '<linuxDefault>'

[darwin]

dotfiles = '<macosDefault>'

json

.dotfiles/config.json

{
  "global": {
    "link_type": "<globalDefault>"
  },
  "windows": {
    "dotfiles": "<windowsDefault>"
  },
  "linux": {
    "dotfiles": "<linuxDefault>"
  },
  "darwin": {
    "dotfiles": "<macosDefault>"
  }
}

If no global, windows, linux or darwin key is provided the global key will be assumed.

yaml

.dotfiles/config.yaml

link_type: <globalDefault>

toml

.dotfiles/config.toml

link_type = '<globalDefault>'

json

.dotfiles/config.json

{
  "link_type": "<globalDefault>"
}