dfm

README

dfm

A dotfile manager for lazy people and pair programmers.

Dotfile Manager will allow you to create "profiles" for dotfiles underneath one unix account and easily switch between them. It requires a git repo with your dotfiles in it and that the dotfiles be placed how you want them represented in your home directory.

It does not require that the dotfiles in your repo start with dots though it handles either case equally well.

Installation

The easiest (and currently only) way to install dfm is using go

$ go get github.com/chasinglogic/dfm

Updating

Make sure dfm is updated to bring in the latest bug fixes and features. If you are installing dfm for the first time, you can skip this step.

go get -u github.com/chasinglogic/dfm

Usage

NAME:
   dfm - Manage dotfiles.

USAGE:
   dfm [global options] command [command options] [arguments...]

VERSION:
   1.0

AUTHOR(S):
   Mathew Robinson <chasinglogic@gmail.com>

COMMANDS:
     add, a      Add a file to the current profile.
     clone, c    Create a dotfiles profile from a git repo.
     link, l     Recreate the links from the dotfiles profile.
     list, ls    List available profiles
     pull, pl    Pull the latest version of the profile from origin master.
     push, ps    Push your local version of the profile to the remote.
     remove, rm  Remove the profile and all it's symlinks.
     remote, re  Will show the remote if given no arguments otherwise will set
the remote.
     init, i     Create a new profile with `NAME`
     commit, cm  Runs git commit for the profile using `MSG` as the message
     status, st  Runs git status for the current or given profile.
     git, g      Runs the git command given in the current profile dir directly
.
     where, w    Prints the CurrentProfile directory, useful for using with oth
er bash commands
     help, h     Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --config DIR, -c DIR  Use DIR for storing dfm configuration and profiles (de
fault: "/Users/mathewrobinson/.config/dfm")
   --verbose, --vv       Print verbose messaging.
   --dry-run, --dr       Don't create symlinks just print what would be done.
   --help, -h            show help
   --version, -v         print the version

dfm is mostly a thin wrapper around git and just manages repos and symlinks for you. As such most of the dfm commands are directly analogous to git commands.

A note about the $XDG_CONFIG_HOME (commonly $HOME/.config) directory:

dfm respects dotfiles which exist in the $XDG_CONFIG_HOME directory, meaning if in your repo you have a folder named config or .config it will translate those into the $XDG_CONFIG_HOME directory appropriately. Similarly when using dfm add if inside your $XDG_CONFIG_HOME or $HOME/.config directories it will add those to the repo appropriately.

Quick Start (Existing dotfiles repo)

If you already have a dotfiles repo you can start by cloning it using the clone command.

Note: ssh urls will work as well.

dfm clone https://github.com/chasinglogic/dfiles

If you're using github you can shortcut the domain:

dfm clone chasinglogic/dfiles

If you want to clone and link the dotfiles in one command:

dfm clone --link chasinglogic/dfiles

You may have to use --force as well if you have existing non-symlinked versions of your dotfiles

Once you have multiple profiles you can switch between them using dfm link

dfm link some-other-profile

See the Usage Notes below for some quick info on what to expect from other dfm commands.

Quick Start (No existing dotfiles repo)

If you do not have a dotfiles repo the best place to start is with dfm init

dfm init my-new-profile

Then run dfm link to set it as the active profile, this is also how you switch profiles

dfm link my-new-profile

Once that is done you can start adding your dotfiles

dfm add ~/.bashrc

Alternatively you can add multiple files at once

dfm add ~/.bashrc ~/.vimrc ~/.vim ~/.emacs.d

Then simply run dfm commit to commit them

dfm commit -am "init dotfile repo"

Then set the remote to your remote repo

Note: When creating the remote repo do not choose any options such as "initialize this repo with a README" otherwise git will get cranky when you add the remote because of a recent git update and how it handles unrelated histories if you do don't worry the linked post explains how to get past it.

dfm remote https://github.com/myusername/dotfiles

Then simply push them up

dfm push

Now you're done!

A quick note about git commands and flags

dfm does always simply push your commands directly through to git.

The git sub command will push directly through so you can run whatever you want as if you were in that directory. For example:

dfm git checkout -b my-work-laptop

Stdin, Stdout, and Stderr are given to git so even things that run a text editor for example will work as expected.

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. 🔥 Submit a pull request :D 🔥

All pull requests should go to the develop branch not master. Thanks!

License

This code is distributed under the GNU General Public License

    Copyright (C) 2017 Mathew Robinson

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.