Home

Table of contents

• How does it work?
• Usage
• Installation
  • Completion
• Commands
  • link
  • clone
  • pull
  • check
  • list
  • track
  • generate
  • refresh
  • cd
• Tutorial
  • Bootstrapping
  • Adding other machines
  • Refreshing
  • Updating your castle
• Symlinking
  • Linking table
  • Deep symlinking vs. flat symlinking
• Repos with no home
• Automatic deployment
• 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 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. Each repo is referred to as a castle.

Usage

homeshick is used via subcommands, so simply typing homeshick will yield a helpful message that tersely explains all of the things you can do with it.

Most subcommands accept castlenames as arguments. You can also run a subcommand on all castles by not specifying any arguments.