Project

homeconf

0.0
No release in over a year
Homeconf is a Ruby program to create and manage a single directory for all home directory configuration.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 3.1.1, >= 3.0.0
~> 3.2.1, >= 3.2.0
~> 3.12, >= 3.0.0
~> 1.0.0, >= 1.0.0
 Project Readme

homeconf

homeconf is a Ruby utility to create and manage your home directory files and configuration in a single, portable, version controllable directory.


Installation

homeconf's installation is pretty standard:

$ gem install homeconf

If you'd rather install homeconf using bundler, add a line for it in your Gemfile (but set the require option to false, as it is a standalone tool):

gem 'homeconf', require: false

Quickstart

Just type homeconf to see your homeconf directory and if it's initialized.

$ cd
$ homeconf

Create homeconf directory

Create your homeconf directory and start adding files and directories.

$ cd
$ homeconf --create

Initialize to create symlinks

You can add files and directories to your homeconf directory, then initialize to create symlinks from your home directory.

$ echo "echo 'hello world'" > ~/homeconf/hello.sh
$ mkdir ~/homeconf/my_scripts
$ homeconf --init

Add files and directories

Move existing files and directories into homeconf directory. Homeconf will create the symlink from your home directory.

$ homeconf --add .zshrc
$ homeconf --add bin

See configuration

Run with verbose to see homeconf files and directories, and whether they're linked.

$ homeconf --verbose