Home

Table of contents

• How does it work?
• Installation
  • Completion (bash zsh)
• Commands (link clone pull check list track generate refresh cd)
  • Switches (quiet skip force batch)
• Tutorials
  • Bootstrapping
  • Adding other machines
  • Refreshing
  • Updating your castle
• Automatic deployment
• Symlinking
  • Linking table
  • Combining directories
  • Repos with no home directory
  • Shallow symlinking
  • Files outside your home directory
• Testing
  • Fixtures
  • Interactive testing
  • GNU coreutils on OSX
  • Dependencies
• homeshick and homesick

How does it work?

Symlinking. On the simplest level, all homeshick really does is look for files and folders in your cloned repositories and symlink them to your home directory (the linking table explains the symlinking process in more detail). The symlinked files must however reside in a folder named home. This way you can prevent homeshick from cluttering your home folder with files that are only included from elsewhere.

A repository managed by homeshick is referred to as a castle.