Project

gitenv

0.0
A long-lived project that still receives updates
Gitenv sets up symlinks to your configuration files in a git repository.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 2.0
~> 13.0

Runtime

~> 4.6
~> 2.2
 Project Readme

gitenv

Creates symlinks to your configuration files in a git repository (like mine).

Gem Version Build Code Coverage

Run gitenv without arguments to check the symlink configuration. First-time users will be prompted to enter the path to their environment repository so gitenv can set up its own config file.

#=> gitenv

 ~/.gemrc -> ~/projects/env/.gemrc           ok
 ~/.gitconfig -> ~/projects/env/.gitconfig   not yet set up
 ~/.zshrc -> ~/projects/env/.zshrc           not yet set up

Then run it with apply to set up the missing symlinks.

#=> gitenv apply

 ~/.gemrc -> ~/projects/env/.gemrc           ok
 ~/.gitconfig -> ~/projects/env/.gitconfig   ok
 ~/.zshrc -> ~/projects/env/.zshrc           ok

Read on for more advanced options.

Installation

gem install gitenv

Configuration

If your repository is more complex than a bunch of dot files or you want to put the links somewhere other than in your home folder, you will have to customize your configuration file. Gitenv prompts you to create one the first time you run it. It looks for ~/.gitenv.rb by default. You can override this with the -c, --config option or by setting the GITENV_CONFIG environment variable.

The following sections demonstrate the various options you can customize in the configuration file.

Repository

# Path to your environment repository.
repo '~/projects/env'

# Note that you can also set the GITENV_REPO environment variable.

Symlinks

# This will create symlinks in your home folder to all dot files (e.g. .vimrc, .gitconfig) in the repository.
symlink dot_files

# This creates symlinks for all files, not just dot files.
symlink all_files

# You can also create symlinks one at a time.
symlink '.zshrc'
symlink 'my_config_file'

# If you want the name of link to be different than that of the file, use the :as option.
symlink 'zshconfig', :as => '.zshconfig'

Sub-folders in the repository

# If your configuration file or files are in a sub-folder, use #from to tell gitenv where to find them.
from 'subfolder' do
  symlink dot_files
end

# The following syntax is also available.
symlink('.zshrc').from('zsh')
symlink(all_files).from('a/b/c')

# You can chain several #from calls to traverse hierarchies.
from 'a' do
  from 'b' do
    from 'c' do
      # Symlink all dot files in a/b/c in your repository.
      symlink dot_files
    end
  end
end

Change the destination

# If you want to put the symlinks somewhere other than in your home folder, use #to.
to 'links' do
  symlink dot_files
end

# The following syntax is also available.
symlink('.zshrc').to('links')
symlink(all_files).to('a/b/c')

# Paths are relative to your home folder. If you need an absolute path, use #to_abs.
symlink('my_config_file').to_abs('/opt/config')

Copy files

# Gitenv can also copy files instead of creating symlinks.
copy dot_files

# Path modifiers work the same as for symlinks.
copy(dot_files).from('zsh')
copy('my_config_file').to('configs')

Symlinks or copies in system directories

Just use sudo. Gitenv will happily set up your symlinks. You might have to add the -E switch to keep gitenv in the PATH.

License (MIT)

Copyright (c) 2011 Alpha Hydrae

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.