hideDot

A blazing fast dotFiles manager written in Go

View on GitHub Get Started

Features

🚀

Fast Symlink Management

Quickly manage and organize all your symlinks with blazing speed.

🏠

Home Directory Expansion

Automatic expansion of home directory paths using the tilde (~/) symbol.

🔄

Git Repository Cloning

Easily clone and manage your Git repositories in one place.

🛠️

Shell Command Execution

Run shell commands as part of your dotfiles setup process.

🔍

Duplicate Detection

Automatically detect and handle duplicate symlinks in your system.

🧪

Dry-Run Mode

Preview changes before applying them with a comprehensive dry-run mode.

Getting Started

1Installation

Install hideDot using Homebrew:

brew tap youhide/homebrew-youhide
brew install hidedot

2Create Configuration

Create a hidedot.conf.yaml file:

- defaults:
    link:
      relink: true
      force: true
  
  # Create directories
  create:
    - ~/.config
    - ~/.local/bin
  
  # Manage symlinks
  link:
    ~/.config/nvim: ~/.mydotfiles/nvim
    ~/.zshrc: ~/.mydotfiles/zsh/zshrc
  
  # Clone git repositories
  git:
    ~/.oh-my-zsh:
      url: https://github.com/ohmyzsh/ohmyzsh.git
      description: "Oh My Zsh"

  # Run shell commands
  shell:
    - [touch ~/.hushlogin, Create hushlogin]

3Run hideDot

Execute hideDot with your configuration file:

hidedot --config path/to/hidedot.conf.yaml

Or run in dry-run mode to preview changes:

hidedot --dry-run --config path/to/hidedot.conf.yaml

Command Options