volllly / rotz Goto Github PK

Provide simple install scripts to install rotz like this:

curl github.com/volllly/rotz/releases/download/latest/install.sh | sh

irm github.com/volllly/rotz/releases/download/latest/install.ps1 | iex

The script should be automatically published in the releases and download the correct binary into a folder that makes sense. Maybe there is a common way to do these things. For windows we could look at how scoop installs itsself.

Add a code tour using https://github.com/microsoft/codetour for learning the codebase.

Hey there, I'm looking for a crossplatform dotfile managing solution, and stumbled across Dotted/Rotz. My main OS is Windows but I have several devices running several different Linux distros. I'm happy to keep using scoop/other package managers to managing installing/uninstalling/updating programs, but I was just wondering if Rotz was ready to use now purely as an alternative to stow for dotfile managing, or if I should use something else in the meantime?

I would like to add Rotz to some package managers to ease installation.

My initial thoughts are:

• scoop and winget for windows
• homebrew on macos
• nix, snap or flatpak for linux.

but this is open for debate 😄

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update actions/checkout digest to 0ad4b8f
• fix(deps): update dependency clsx to v2.1.1
• fix(deps): update dependency yaml to v2.4.2
• fix(deps): update crates (junction, serde, serde_json, thiserror)
• fix(deps): update docusaurus monorepo to v3.3.2 (@docusaurus/core, @docusaurus/module-type-aliases, @docusaurus/preset-classic)
• fix(deps): update react monorepo to v18.3.1 (react, react-dom)
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• fix(deps): update dependency prism-react-renderer to v2

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Hey,
I really like the idea of rotz. I saw the example for installs and was missing the ability to install a list of tools.

Let me outline my idea:

• I have config.yaml with variables

variables:
  packages:
    darwin:
      - visual-studio-code
      - vim
      - rustup
    linux:
      - vscode
      - emacs
      - golang

• I have a dot.yaml where I want to install a set of packages

darwin:
  installs:
    cmd: brew install {{ <package> }}
    # packages: {{ variables.darwin }}
    depends:
      - brew
linux:
  installs:
    cmd: yay install {{ <package> }}
    # packages: {{ variables.darwin }}
    depends:
      - yay

• As rotz supports arrays, there could be a packages property for installs to install more than one package with cmd

Does this make any sense?

I'm happy to discuss the idea or answer any follow-up questions :)

Cheers
Stefan

We should update the CI build to add a *.zip.sha256 file to each of the the targets and publish that file in releases.

Hi there. As the title says i'm getting this error when i try to run the sync command under Windows.

Error: glob::set::parse

x Could not build GlobSet
`-> failed to parse glob expression

I don't know if i'm doing something wrong but i just initialize rotz with rotz init, then add things into the .dotfiles folder and then i've tried the sync command and got this error.

First off, fantastic package! My dotfiles are sooo much cleaner than when my old dotbot iteration, zero regrets on making the jump, thanks for your hard work on this 💗✨.

One thing I just encountered in trying to refactor from using a giant Brewfile to relying on Rotz for my brew installs: it seems that the {{ name }} of a subdirectory within a subdirectory includes the parent subdirectory. This makes it impossible (? or tricky at least) to use a defaults.yaml with a package manager to install using the suggested pattern:

# defaults.yaml
installs:
  cmd: brew install {{ name }}
  depends:
    - brew

For example, with the below setup (tools dir is in the root of my dotfiles), the above pattern attempts to do this brew install tools/yazi, brew install tools/atuin...etc.

tools
├── atuin
│   ├── atuin.toml
│   └── dot.yaml
├── dbt
│   └── dot.yaml
├── defaults.yaml
├── dust
│   └── dot.yaml
├── karabiner
│   ├── dot.yaml
│   └── karabiner.json
├── sunbeam
│   ├── dot.yaml
│   └── xn.py
└── yazi
    ├── Catppuccin-frappe.tmTheme
    ├── dot.yaml
    ├── keymap.toml
    ├── theme.toml
    └── yazi.toml

This is on MacOS Sonoma 14.4.1, Rotz version 0.10.0. Let me know if you need other details. Thanks again!

Is it possible to reference environment variables in the yaml files?

Add an init command to initialize a new dotfiles repository and config file.

A simple dot.yaml config like this fails:

links:
    Microsoft.PowerShell_profile.ps1: ~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1

> rotz link powershell
Linking powershell

  Microsoft.PowerShell_profile.ps1 -> ~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1

 Error: link::linking

  × Could not create link from "C:
  │ \Users\Michael\.dotfiles\powershell\Microsoft.PowerShell_profile.ps1" to "C:
  │ \Users\Michael\Documents\PowerShell\Microsoft.PowerShell_profile.ps1"
  ╰─▶ The system cannot find the path specified. (os error 3)
  help: You may need to run rotz from an admin shell to create file links

Creating the directory Powershell manually fixes the issue. It would be nice if Rotz was able to create the missing directories, because with installs not working yet I can't even run a script that creates the directory.

I've been trying to get defaults to work, but so far i cant seem to get it working the way i would like to.
My default.toml file is just
[linux] [linux.installs] cmd: sudo pacman --needed --noconfirm -S {{ name }}
But how do i actually get a dot for a particular application to use it?
Assuming i just want to install something, without any other actions (no linking etc.)
Do i just put in an empty file in the respective folder, or do i put something in it?

(Just migrated over to rotz, really nice - thanks!)

We can set install commands per OS (eg, Darwin vs Linux), but there's no way to set different install commands per distro.

In my case, I use Darwin, Ubuntu and Arch Linux. I can have different commands in defaults.yml for darwin and linux, but my linux command can be either apt or pacman which means install will only work on 1 of those distributions.

Current

linux:
  installs: sudo apt install -y {{ name }}

darwin:
  installs:
    cmd: brew install {{ name }}
    depends:
      - brew

Desired (Suggestion)

Reading /etc/os-release (if available) could let us define keys based on the value of ID perhaps:

linux:
  ubuntu:
    installs: sudo apt install -y {{ name }}
  arch:
    installs: sudo pacman -S --noconfirm {{ name }}

darwin:
  installs:
    cmd: brew install {{ name }}
    depends:
      - brew

It would be nice to add an existing folder/file to be tracked by rotz.

E.g. something like rotz edit vscode add --windows ~/AppData/Roaming/Code/User/snippets/ snippets would add this folder to the vscode/dot.yaml file windows links, copy the folder to vscode/snippets in the repo and create the symlink.

Discussed in #52

Recurse nested folders and treat dot names as paths. If the folders contain a defaults file merge it with the parent defaults and use it for child dots.

Dot names in the cli and the depends sections are glob patterns.

rotz install devtools/* installs all dots in the devtools folder.

rotz install **/vim installs all dots named vim in any folder.

rotz install * installs all dots in the root folder (like before).

rotz install ** installs all dots in any folder.

depends: [ ../package-managers/scoop ] uses a path relative to the current dot.

Use https://docs.rs/git-repository/ or https://docs.rs/git2/latest/git2/ to perform git actions instead of relying on a local git installation.

rotz is missing a sanity check on links.

PEBKAC from your servitor here happened:
I have a file named config declared as :

links:
  condig:~/.gitconfig

As you can see, there is a typo in the name.
rotz then created a dead link.

i don't think rotz should create deadlinks, it should error, telling the file condig does not exists (and optionally, telling me i am stupid :) ).

PS: Thanks for the tool!

The following dot does not parse right now because link keys which contain a string and an array cannot be mixed at the moment.

links:
  some: thing
  an: [ arr, ay ]

First of all... Why did I not find this earlier??? Such a great tool! Rust and cross platform, best combo!

I know this project is in its early steps and also only you, @volllly , develop it, so I guess you dont have the time to package it to all platforms. As a temporary solution can you add a step to github actions to build binaries for several platforms? Also add some example one-liner to curl / wget / Invoke-WebRequest them to ~/.bin or something. It would be much easier to not install rust on every computer.

My dotfiles repo mirrors my $HOME (like a lot of dotfiles repos i guess), so my dot.yaml currently consists of:

links:
     filename: ~/filename

And it's just a bunch of thing: ~/thing for every file or folder that exists in the repo.

Would it be possible to do

copy to: ~/
links:
    - filename
    - other filename

maybe with a different key than links to avoid parsing complexity (idk if rust is like Go where decoding YAML into a data structure imposes somewhat strict requirements on the shape of the input yaml data)

I can whip up a PR