rotz

You can define a defaults.yaml file in any folder within your repository. These files provide default values that are automatically applied to subdirectories when keys are missing from the local dot.yaml files. This allows you to define common configurations at a higher level in the directory tree and only override specific keys in nested dot.yaml files.

# Example: defaults.yaml in a parent directory
installs:
  cmd: 'scoop install {{ name }}'
  depends:
    - 'scoop'
    - 'extras'

When defining values in defaults.yaml, you can use template strings like {{ name }}. The {{ name }} placeholder is automatically substituted with the name of the application, which is defined as the name of the folder containing the dot.yaml file. For more complex logic, refer to the templating documentation.

# If this is in a folder named 'myapp', {{ name }} becomes 'myapp'
cmd: 'scoop install {{ name }}'

For more granular control, you can append a selector to an OS key to differentiate between OS versions, distributions, or machine properties.

A selector follows the pattern: os_key[property.path="value"].

Supported operators:

• =: Equality (linux[whoami.username="me"])
• ^=: Starts with (linux[whoami.distro^="Ubuntu"])
• $=: Ends with (linux[whoami.realname$="Doe"])
• *=: Contains (linux[whoami.arch*="64"])
• !=: Not equal to (linux[config.variables.profile!="work"])

You can chain multiple selectors together (e.g., linux[key1="val1"][key2="val2"]) or combine different OS selectors using the | operator.

['linux[whoami.distro^="Ubuntu"]']
installs = 'sudo apt install -y {{ name }}'

['linux[whoami.distro^="Arch"]']
installs = 'sudo pacman -S --noconfirm {{ name }}'

On Linux and MacOS, you can install Rotz using the Homebrew package manager.

brew install volllly/tap/rotz

To generate the static content for the website, run yarn build. The resulting static files will be located in the build directory and can be hosted using any static content hosting service.

$ yarn build

Rotz is a cross-platform dotfile manager and dev environment bootstrapper. It provides three main functionalities:

1. Linking dotfiles: Connect files from a common repository to your system.
2. Installing applications: Bootstrap a new or empty machine with necessary tools.
3. Cross-platform configuration: Manage settings across different operating systems.

Basic Workflow

1. Clone your dotfiles repository: Use the clone command to bring your existing configuration into Rotz.
2. Bootstrap your environment: Use install to set up the applications required for your development environment.
3. Link your dotfiles: Use link to map your configuration files to the correct locations on your system.

# Clone a repository
rotz clone git@github.com:<user>/<repo>.git

# Bootstrap applications
rotz install

# Link dotfiles
rotz link

To provide default settings for anyone using your repository, you can place a configuration file (e.g., .dotfiles/config.yaml) inside the repo. This file can define platform-specific overrides that are automatically superseded by the user's local machine configuration.

Supported platform keys:

• global: Used if no platform-specific key is matched.
• windows: Windows-specific settings.
• linux: Linux-specific settings.
• darwin: MacOS-specific settings.

# .dotfiles/config.yaml
global:
  link_type: 'symbolic'
windows:
  dotfiles: '<windowsDefault>'
linux:
  dotfiles: '<linuxDefault>'
darwin:
  dotfiles: '<macosDefault>'

On Windows, you can install Rotz using the Scoop package manager. You must first add the volllly bucket before installing.

scoop bucket add volllly https://github.com/volllly/scoop-bucket
scoop install volllly/rotz

When dotfiles are organized in subdirectories, you can specify dependencies using paths. These paths can be:

• Relative paths: Relative to the current dot.yaml file.
• Absolute paths: Relative to the root of the dotfiles repository.

Example of a relative dependency path:

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