vaelatern / init-dotfiles

Quickly get your dotfiles up and running

Init Dotfiles

The problem: Everybody and their grandma has a way to manage an existing dotfiles repository. However, there is no easy way create a dotfiles repository to start with. Even if someone uses a dotfile manager, they still need to move files themselves, go through the manager install and configuration process, and setup a repository under version control.

We aim to do all of this for you. All you need to do is run it, and give it permission to do everything it does.

Currently, the script is designed for use with Dotbot dotfile manager and git.

Get Running in 5 Minutes

  curl -fsSLO https://raw.githubusercontent.com/Vaelatern/init-dotfiles/master/init_dotfiles.sh
  chmod +x ./init_dotfiles.sh
  ./init_dotfiles.sh

Usage

• test - Test mode. Nothing will actually be done. Best if you are wary about the whole thing. Default: No.

• verbose-config - The Dotbot configuration will have every option explicitly set. Default: No.

• dump-config - The configuration will be sent to stdout, perfect for redirecting into a file. Default: No.

• preview - Commands will be printed to the console before being executed. There won't be newlines between them, but you can see what they are. Default: Yes.

• colors - Colorize output. Default: No.

Every command line option can have no- prepended to turn off the option.

For example:

  ./init_dotfiles.sh verbose-config no-preview

Will enable the verbose-config option and disable the preview option.

Contributing

If you want to help out, there are two ways to do that. Either you can open an issue, or you can fork and pull request. If you wanted a file added to your dotfiles that isn't looked for in the script, open an issue.

init-dotfiles's Issues

Put dotfiles paths all on separate lines?

If you split up the stuff in https://github.com/Aviator45003/easy-dotfiles/blob/04fe42ed52e27a5c17c53d068325f21f3eae6144/easy_setup.sh#L85 onto separate lines, you'll get better diffs.

How to set this up?

I'm trying to set this up, but this is overly confusing. What is it asking for here? A git URL? A directory location?

[~] curl -fsSLO https://raw.githubusercontent.com/Vaelatern/init-dotfiles/master/init_dotfiles.sh                                           16:50:37 
[~] chmod +x ./init_dotfiles.sh                                                                                                             16:55:30 
[~] ./init_dotfiles.sh                                                                                                                      16:55:33 
Welcome to the configuration generator for Dotbot
Please be aware that if you have a complicated setup, you may need more customization than this script offers.

At any time, press ^C to quit. No changes will be made until you confirm.

~/.dotfiles is not in use.
Where do you want your dotfiles repository to be? (~/.dotfiles) y
FEATURE NOT YET SUPPORTED.
Sorry for misleading you.

Where do you want your dotfiles repository to be? (~/.dotfiles) ~/.dotfiles
FEATURE NOT YET SUPPORTED.
Sorry for misleading you.

Where do you want your dotfiles repository to be? (~/.dotfiles) ~
FEATURE NOT YET SUPPORTED.
Sorry for misleading you.

Where do you want your dotfiles repository to be? (~/.dotfiles) github
FEATURE NOT YET SUPPORTED.
Sorry for misleading you.

Where do you want your dotfiles repository to be? (~/.dotfiles) git
FEATURE NOT YET SUPPORTED.
Sorry for misleading you.

Where do you want your dotfiles repository to be? (~/.dotfiles) 

Yes, I tried many random things.

Pretty print dotbot setup actions

Would be a lot easy to read if newline separated, especially the content of the install.conf.yaml file

Quick install not working

I'm following the "Get Running in 5 minutes" section in the readme.

I can download the install file fine on the first line:
curl -fsSLO https://raw.githubusercontent.com/Vaelatern/init-dotfiles/master/init_dotfiles.sh

But when I run ./init_dotfiles.sh I get an error:
zsh: permission denied: ./init_dotfiles.sh

Fail fast on error

It's usually a good idea to set the set -e and set -x options in the script if you can. Failing fast on errors is usually a good thing. It might require reworking some of the things (if a command is allowed to fail, you can explicitly add something like || true, and stuff like that).

Use default git commit name/email if not set already?

If a user doesn't have user.name or user.email set in their gitconfig, then the git commit -m "Initial commit" step will fail.

Is this the right way to handle that scenario? Or is it better to prompt the user? Or is it better just to use some default name/email like easy-dotfiles <aviator45003/easy-dotfiles>.

Colours

It would be nice to have the option colors to enable colouring of the output. Right now, it's hard to read all the text. I'll look into it.

weird error on Mac OS X

Hello
i tried init-dotfiles, but it doesn´t work correctly.
here is the "log":

Welcome to the configuration generator for Dotbot
Please be aware that if you have a complicated setup, you may need more customization than this script offers.

At any time, press ^C to quit. No changes will be made until you confirm.

~/.dotfiles is not in use.
Where do you want your dotfiles repository to be? (~/.dotfiles)
Shall we add Dotbot as a submodule (a good idea)? (Y/n)
Will do.
Do you want Dotbot to clean ~/ of broken links added by Dotbot? (recommended) (Y/n)
I will ask Dotbot to clean.
I found ~/.bash_profile, do you want to Dotbot it? (Y/n) n
Not added to Dotbot.
I found ~/.gitconfig, do you want to Dotbot it? (Y/n)
Dotbotted!
I found ~/.ssh/config, do you want to Dotbot it? (Y/n)
Dotbotted!
I found ~/.tmux.conf, do you want to Dotbot it? (Y/n)
Dotbotted!
I found ~/.zshrc, do you want to Dotbot it? (Y/n)
Dotbotted!
expr: syntax error
expr: syntax error
expr: syntax error
expr: syntax error
expr: syntax error
expr: syntax error
expr: syntax error
expr: syntax error
expr: syntax error
expr: syntax error
expr: syntax error
expr: syntax error
Shall I run the installer? (Necessary to git commit) (Y/n)
Will do.
Shall I make the initial commit? (Y/n)
Will do.

i am running init-dotfiles on a mac osx 10.10.3