dot.yaml

Sections

• Sections
• links
• installs
• depends
• Nesting

The dot.yaml file consists of four optional keys:

key	requirement	function
links	optional	Defines where to link which dotfile
installs	optional	Defines the install command and install dependencies.
depends	optional	Defines dependencies this application needs to work.

links

The links section specifies where the dotfiles should be linked.

It consists of multiple key: value pairs where the key is the filename of the dotfile and the value is the link path.

yaml

Example: vscode/dot.yaml

...

links:
  keybindings.json: ~/AppData/Roaming/Code/User/keybindings.json
  settings.json: ~/AppData/Roaming/Code/User/settings.json

toml

Example: vscode/dot.toml

...

[links]

'keybindings.json' = '~/AppData/Roaming/Code/User/keybindings.json'
'settings.json' = '~/AppData/Roaming/Code/User/settings.json'

json

Example: vscode/dot.json

{
...

  "links": {
    "keybindings.json": "~/AppData/Roaming/Code/User/keybindings.json",
    "settings.json": "~/AppData/Roaming/Code/User/settings.json"
  }
}

installs

The installs section contains the install command and optional install dependencies.

It can either be a string containing the install command or have two sub keys.

key	requirement	function
cmd	required	Contains the install command.
depends	optional	Contains an array of dependencies.

yaml

Example: nodejs/dot.yaml

...

installs:
  cmd: scoop install nodejs
  depends:
    - scoop

toml

Example: nodejs/dot.toml

...

[installs]

cmd = 'scoop install nodejs'
depends = [
  'scoop',
]

json

Example: nodejs/dot.json

{
...

  "installs": {
    "cmd": "scoop install nodejs",
    "depends": [
      "scoop"
    ]
  }
}

yaml

Example: scoop/dot.yaml

...

installs: iex (new-object net.webclient).downloadstring('https://get.scoop.sh')

toml

Example: scoop/dot.toml

...

installs = "iex (new-object net.webclient).downloadstring('https://get.scoop.sh')"

json

Example: scoop/dot.json

{
...

  "installs": "iex (new-object net.webclient).downloadstring('https://get.scoop.sh')"
}

note

The command can also be set to false. This overwrites the value set in the defaults defaults.yaml file.

depends

The depends section contains an array of dependencies needed for the application to work correctly.

These dependencies will also be installed when the application is installed.

yaml

Example: zsh/dot.yaml

...

depends:
  - starship

toml

Example: zsh/dot.toml

...

depends = [
  'starship',
]

json

Example: zsh/dot.json

{
...

  "depends": [
    "starship"
  ]
}

Nesting

If you have dots nested in subdirectories dependencies need to specify them as a path.

This can either be a path relative to the current dot or an absolute path (the dotfiles repo is used as root).

yaml

Example: Directory layout

├── some
│   └── thing
│       └── nested
│           └── dot.yaml
└── other
  └── directory
          └── dot.yaml

toml

Example: Directory layout

├── some
│   └── thing
│       └── nested
│           └── dot.toml
└── other
  └── directory
          └── dot.toml

json

Example: Directory layout

├── some
│   └── thing
│       └── nested
│           └── dot.json
└── other
  └── directory
          └── dot.json

yaml

Example: relative path "some/thing/nested/dot.yaml"

depends:
  - ../../other/directory

toml

Example: relative path "some/thing/nested/dot.toml"

depends = [
  '../../other/directory',
]

json

Example: relative path "some/thing/nested/dot.json"

{
  "depends": [
    "../../other/directory"
  ]
}

yaml

Example: absolute path "editors/vscode/dot.yaml"

depends:
  - /other/directory

toml

Example: absolute path "editors/vscode/dot.toml"

depends = [
  '/other/directory',
]

json

Example: absolute path "editors/vscode/dot.json"

{
  "depends": [
    "/other/directory"
  ]
}