Top Related Projects
💻 macOS / Ubuntu dotfiles
A curated list of dotfiles resources.
Quick Overview
Holman/dotfiles is a comprehensive collection of configuration files (dotfiles) and scripts for setting up and customizing a macOS development environment. It includes configurations for various tools, applications, and system settings, aimed at streamlining the setup process and enhancing productivity for developers.
Pros
- Extensive coverage of common developer tools and applications
- Well-organized structure with topic-based folders for easy navigation
- Includes a bootstrap script for automated setup and installation
- Customizable and easily extendable to fit personal preferences
Cons
- Primarily focused on macOS, limiting its usefulness for other operating systems
- May include configurations for tools that not all users need or want
- Requires some familiarity with command-line tools and dotfiles concepts
- Potential for conflicts with existing configurations if not carefully implemented
Getting Started
To get started with holman/dotfiles:
-
Clone the repository:
git clone https://github.com/holman/dotfiles.git ~/.dotfiles
-
Navigate to the dotfiles directory:
cd ~/.dotfiles
-
Run the bootstrap script:
script/bootstrap
-
Review and customize the configurations in the topic folders as needed.
-
Restart your terminal or run
source ~/.zshrc
to apply the changes.
Note: It's recommended to review the configurations and remove or modify any settings that conflict with your existing setup or preferences before running the bootstrap script.
Competitor Comparisons
💻 macOS / Ubuntu dotfiles
Pros of alrra/dotfiles
- More comprehensive and detailed documentation
- Includes support for multiple operating systems (macOS, Ubuntu, CentOS)
- Offers a wider range of configuration files and tools
Cons of alrra/dotfiles
- Less modular structure compared to holman/dotfiles
- May be overwhelming for beginners due to its extensive nature
- Requires more manual setup and customization
Code Comparison
holman/dotfiles:
# Load all the files in the zsh directory
for file in ~/.dotfiles/**/*.zsh; do
source "$file"
done
alrra/dotfiles:
declare -r DOTFILES_DIR_PATH="$(dirname "${BASH_SOURCE[0]}")"
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
. "$DOTFILES_DIR_PATH/src/os/utils.sh"
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
main() {
# Load utils
. "$DOTFILES_DIR_PATH/src/os/utils.sh"
The code snippets show different approaches to loading configuration files. holman/dotfiles uses a simple loop to source all .zsh files, while alrra/dotfiles employs a more structured approach with separate utility functions and a main() function for initialization.
A curated list of dotfiles resources.
Pros of awesome-dotfiles
- Comprehensive collection of dotfiles resources and tools
- Regularly updated with community contributions
- Provides a curated list of dotfiles from various developers
Cons of awesome-dotfiles
- Not a ready-to-use dotfiles setup
- Requires more effort to implement and customize
- May be overwhelming for beginners due to the vast amount of information
Code comparison
dotfiles:
# Load the shell dotfiles, and then some:
# * ~/.path can be used to extend `$PATH`.
# * ~/.extra can be used for other settings you don't want to commit.
for file in ~/.{path,bash_prompt,exports,aliases,functions,extra}; do
[ -r "$file" ] && [ -f "$file" ] && source "$file"
done
unset file
awesome-dotfiles:
## Tools
- [Dotbot](https://github.com/anishathalye/dotbot) - A tool that bootstraps your dotfiles
- [rcm](https://github.com/thoughtbot/rcm) - rc file (dotfile) management
- [homeshick](https://github.com/andsens/homeshick) - Git dotfile synchronizer written in Bash
- [mackup](https://github.com/lra/mackup) - Keep your application settings in sync
- [yadm](https://yadm.io) - Yet Another Dotfiles Manager
The dotfiles repository provides a ready-to-use setup with shell scripts and configuration files, while awesome-dotfiles offers a curated list of resources and tools for managing dotfiles. dotfiles is more suitable for users looking for a quick start, while awesome-dotfiles is better for those who want to explore various options and create a custom setup.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
holman does dotfiles
Your dotfiles are how you personalize your system. These are mine.
I was a little tired of having long alias files and everything strewn about (which is extremely common on other dotfiles projects, too). That led to this project being much more topic-centric. I realized I could split a lot of things up into the main areas I used (Ruby, git, system libraries, and so on), so I structured the project accordingly.
If you're interested in the philosophy behind why projects like these are awesome, you might want to read my post on the subject.
topical
Everything's built around topic areas. If you're adding a new area to your
forked dotfiles â say, "Java" â you can simply add a java
directory and put
files in there. Anything with an extension of .zsh
will get automatically
included into your shell. Anything with an extension of .symlink
will get
symlinked without extension into $HOME
when you run script/bootstrap
.
what's inside
A lot of stuff. Seriously, a lot of stuff. Check them out in the file browser above and see what components may mesh up with you. Fork it, remove what you don't use, and build on what you do use.
components
There's a few special files in the hierarchy.
- bin/: Anything in
bin/
will get added to your$PATH
and be made available everywhere. - topic/*.zsh: Any files ending in
.zsh
get loaded into your environment. - topic/path.zsh: Any file named
path.zsh
is loaded first and is expected to setup$PATH
or similar. - topic/completion.zsh: Any file named
completion.zsh
is loaded last and is expected to setup autocomplete. - topic/install.sh: Any file named
install.sh
is executed when you runscript/install
. To avoid being loaded automatically, its extension is.sh
, not.zsh
. - topic/*.symlink: Any file ending in
*.symlink
gets symlinked into your$HOME
. This is so you can keep all of those versioned in your dotfiles but still keep those autoloaded files in your home directory. These get symlinked in when you runscript/bootstrap
.
install
Run this:
git clone https://github.com/holman/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
script/bootstrap
This will symlink the appropriate files in .dotfiles
to your home directory.
Everything is configured and tweaked within ~/.dotfiles
.
The main file you'll want to change right off the bat is zsh/zshrc.symlink
,
which sets up a few paths that'll be different on your particular machine.
dot
is a simple script that installs some dependencies, sets sane macOS
defaults, and so on. Tweak this script, and occasionally run dot
from
time to time to keep your environment fresh and up-to-date. You can find
this script in bin/
.
bugs
I want this to work for everyone; that means when you clone it down it should
work for you even though you may not have rbenv
installed, for example. That
said, I do use this as my dotfiles, so there's a good chance I may break
something if I forget to make a check for a dependency.
If you're brand-new to the project and run into any blockers, please open an issue on this repository and I'd love to get it fixed for you!
thanks
I forked Ryan Bates' excellent dotfiles for a couple years before the weight of my changes and tweaks inspired me to finally roll my own. But Ryan's dotfiles were an easy way to get into bash customization, and then to jump ship to zsh a bit later. A decent amount of the code in these dotfiles stem or are inspired from Ryan's original project.
Top Related Projects
💻 macOS / Ubuntu dotfiles
A curated list of dotfiles resources.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot