hideDot - Blazing Fast dotFiles Manager

Features

🚀

Fast Symlink Management

Quickly manage and organize all your symlinks with blazing speed.

🔙

Automatic Backups

Files are automatically backed up before being overwritten for safety.

📋

Status Command

Check symlink health with OK, MISSING, BROKEN, and MISMATCH states.

🏷️

Profiles

Different configurations for different machines or environments.

📝

Templates

Use variables like hostname, OS, arch in your configuration.

🪝

Hooks

Run custom commands before and after link/shell operations.

🔄

Git Repository Cloning

Easily clone and manage your Git repositories in one place.

🛠️

Shell Commands

Run shell commands with stdin support for creating files.

🧪

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
      backup: true  # Enable automatic backups
  
  profile: personal  # Optional: for multi-machine setups
  
  # 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]
  
  # Hooks for custom actionsto create symlinks:
          # Create symlinks (default command)
hidedot

# Or with custom config
hidedot --config path/to/hidedot.conf.yaml

# Preview changes first
hidedot --dry-run

# Check status of symlinks
hidedot status

# Remove symlinks and restore backups
hidedot unlink --restore



      Commands
      
        link: Create symlinks from config (default)
        status: Show status of all symlinks
        unlink: Remove symlinks (use --restore to restore backups)
        backup create/list: Manage backups
      

      Options


        --config, -c: Specify config file path
        --profile, -p: Only apply configs matching this profile
        --dry-run, -n: Show what would be done without making changes
        --verbose, -v: Enable verbose output
        --quiet, -q: Only show errors
        --no-color: Disable colored output

--no-backup: Disable automatic backups.conf.yaml

Command Options

--dry-run: Show what would be done without making changes
--config: Specify config file path (default: hidedot.conf.yaml)
--no-color: Disable colored output