Skip to content

thoughtbot/rcm

Repository files navigation

rcm

This is a management suite for dotfiles. See the tutorial to get started quickly.

It assumes that you have a separate dotfiles directory, or are interested in creating one.

The programs provided are rcup(1), mkrc(1), rcdn(1), and lsrc(1). They are explained in the tutorial and configured using rcrc(5).

Installation

Arch Linux:

https://aur.archlinux.org/packages/rcm-git/

Debian-based (including Ubuntu):

wget https://thoughtbot.github.io/rcm/debs/rcm_1.2.3-1_all.deb
sudo dpkg -i rcm_1.2.3-1_all.deb

openSUSE/RHEL/CentOS: instructions

Gentoo-based (including Funtoo):

sudo emerge layman
sudo layman -f --overlays https://github.com/bronislav/overlays/raw/master/layman.xml --add bronislav
sudo emerge rcm

OS X:

brew tap thoughtbot/formulae
brew install rcm

Elsewhere:

This uses the standard GNU autotools, so it's the normal dance:

wget https://thoughtbot.github.io/rcm/dist/rcm-1.2.3.tar.gz && \
tar -xvf rcm-1.2.3.tar.gz && \
cd rcm-1.2.3 && \

./configure && \
make && \
make install

For more, see INSTALL.

Programs

  • rcup(1) is the main program. It is used to install and update dotfiles, with support for tags, host-specific files, and multiple source directories.
  • rcdn(1) is the opposite of rcup(1).
  • mkrc(1) is for introducing a dotfile into your dotfiles directory, with support for tags and multiple source directories.
  • lsrc(1) shows you all your dotfiles and where they would be symlinked to. It is used by rcup(1) but is provided for your own use, too.

Support

Pull requests welcome; see CONTRIBUTING.md.

License

Copyright 2013 Mike Burns. BSD license. Copyright 2014 thoughtbot. BSD license.