dotload - Simple and intuitive tool for installing dotfiles on any machine!

Installation · Report Bug · Request Feature

dotload works by cloning the specified user's GitHub dotfiles repository

This tool was created to make it as easy as possible to install dotfiles and other required packages.

This tool makes symbolic links to your dotfiles from ~/.dotload to $HOME directory

It can also make symbolic links to folders (including subfolders) whose name starts with a dot, for example .configs

For example, if you have a file ~/.bashrc on your computer and in the repository, it will be overwritten with a new one from the repository, before cloning them, make sure that they are yours or you have made a backup of previous configurations

You can run without installation on any OS with this command:

bash <(curl -sL https://cutt.ly/dotload) @username

Linux	Termux	macOS	Windows (on msys shell)
✅	✅	✅	✅

dotload @username
dotload @username/repo_name
dotload https://github.com/username/dotfiles.git

Where username is the GitHub username whose dotfiles you want to clone.

repo_name - Name of your dotfiles repository, if not specified - dotfiles name will be used by default

You can also use URLs of repositories such as GitLab, Codeberg, etc.

dotload @username branch_name

dotload @<username> [--branch branch_name | -b branch_name]
dotload <repo_url> [--branch branch_name | -b branch_name]

Where branch_name is the branch of the repository you want to clone. If not specified, the default branch is used. This can be useful if you have multiple machine usage scenarios

Use the --help flag to get help:

dotload --help
# Help page...

You can also add an installation script to your dotfiles repository to fully automate the installation and get more features

The installation file can have the following names and locations:

• install.sh
• install
• bootstrap.sh
• bootstrap
• script/bootstrap
• setup.sh
• setup
• script/setup

If none of these files are found, then any files or folders in your selected dotfiles repository starting with . are automatically symlinked to the $HOME directory.

You can also specify a custom installation script or make it optional in dotload.conf, for this read the dotload.conf documentation

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

You can start developing on GitHub Codespaces right away

Or use the usual method on your computer:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Please make sure to update tests as appropriate.

Also, please read our Code of Conduct, and follow it in all your interactions with the project.

This project is MIT licensed.

See LICENSE

If you like this project, consider supporting it by starring ⭐ it on GitHub, sharing it with your friends, or buying me a coffee ☕