{"id":22261931,"url":"https://github.com/cli-stuff/dotload","last_synced_at":"2026-03-05T16:38:35.819Z","repository":{"id":230770212,"uuid":"780131290","full_name":"cli-stuff/dotload","owner":"cli-stuff","description":"🌠 Simple tool for installing dotfiles on any machine!","archived":false,"fork":false,"pushed_at":"2024-11-19T09:32:57.000Z","size":7678,"stargazers_count":23,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-29T05:29:05.410Z","etag":null,"topics":["automation","configuration","dotfiles","linux","packages","tools"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cli-stuff.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"buy_me_a_coffee":"okinea","custom":"https://donatello.to/okineadev"}},"created_at":"2024-03-31T19:26:20.000Z","updated_at":"2024-11-19T09:31:58.000Z","dependencies_parsed_at":"2024-05-29T16:08:25.773Z","dependency_job_id":"ef659692-dafb-4af0-ada4-e729fa8ed4e4","html_url":"https://github.com/cli-stuff/dotload","commit_stats":null,"previous_names":["okineadev/dotload","cli-stuff/dotload"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cli-stuff%2Fdotload","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cli-stuff%2Fdotload/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cli-stuff%2Fdotload/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cli-stuff%2Fdotload/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cli-stuff","download_url":"https://codeload.github.com/cli-stuff/dotload/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227886279,"owners_count":17834992,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","configuration","dotfiles","linux","packages","tools"],"created_at":"2024-12-03T09:15:11.304Z","updated_at":"2026-03-05T16:38:35.765Z","avatar_url":"https://github.com/cli-stuff.png","language":"Shell","readme":"\u003c!-- markdownlint-disable no-inline-html first-line-h1 --\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/cli-stuff/dotload\"\u003e\n    \u003c!-- https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#specifying-the-theme-an-image-is-shown-to --\u003e\n    \u003cpicture\u003e\n      \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"public/banner-dark.png\" alt=\"Banner\"\u003e\n      \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"public/banner-light.png\" alt=\"Banner\"\u003e\n      \u003cimg src=\"public/banner-dark.png\" alt=\"Banner\"\u003e\n    \u003c/picture\u003e\n  \u003c/a\u003e\n\n\u003cbr\u003e\n\u003cbr\u003e\n\n**dotload** - **Simple** and **intuitive** tool for installing dotfiles on any machine!\n\n[**Installation**](#%EF%B8%8F-installation) · [**Report Bug**](https://github.com/cli-stuff/dotload/issues/new?labels=bug\u0026template=bug_report.md) · [**Request Feature**](https://github.com/cli-stuff/dotload/issues/new?labels=enhancement\u0026template=feature_request.md)\n\n\u003c/div\u003e\n\n## ℹ️ About the project\n\n\u003cbr\u003e\n\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"public/screenshot-dark.png\" alt=\"Screenshot\"\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"public/screenshot-light.png\" alt=\"Screenshot\"\u003e\n  \u003cimg src=\"public/screenshot-dark.png\" alt=\"Screenshot\"\u003e\n\u003c/picture\u003e\n\n\u003cbr\u003e\n\n`dotload` works by cloning the specified user's **GitHub** dotfiles repository\n\nThis tool was created to make it as **easy as possible** to install dotfiles and other required packages.\n\n### 🤔 How does it work?\n\nThis tool makes symbolic links to your dotfiles from `~/.dotload` to `$HOME` directory\n\nIt can also make symbolic links to folders (including subfolders) whose name starts with a dot, for example `.configs`\n\n\u003e [!WARNING]\n\u003e Dotfiles with identical names will be inevitably overwritten with new ones from your repository!\n\nFor 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\n\n## ⚙️ Installation\n\nYou can run without installation on **any** OS with this command:\n\n```bash\nbash \u003c(curl -sL https://cutt.ly/dotload) @username\n```\n\n### Compatibility table\n\n| \u003cdiv\u003e\u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/f/f1/Icons8_flat_linux.svg\" alt=\"Linux logo\" width=\"30\"/\u003e\u003c/div\u003e **Linux** | \u003cdiv\u003e\u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/b/b5/Termux.svg\" alt=\"Termux logo\" width=\"30\"/\u003e\u003c/div\u003e **Termux** | \u003cdiv\u003e\u003cimg src=\"public/macos-dark-logo.svg#gh-light-mode-only\" alt=\"macOS logo\" width=\"30\"/\u003e\u003cimg src=\"public/macos-light-logo.svg#gh-dark-mode-only\" alt=\"macOS logo\" width=\"30\"/\u003e\u003c/div\u003e **macOS** | \u003cdiv\u003e\u003cimg src=\"https://github.com/cli-stuff/dotload/assets/81070564/99544c04-51e7-41b5-95f7-0828cfc97617\" alt=\"Windows logo\" width=\"30\"/\u003e\u003c/div\u003e **Windows** (on [msys shell](https://www.msys2.org/)) |\n| :-------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |\n|                                                                   ✅                                                                    |                                                               ✅                                                               |                                                                                                ✅                                                                                                 |                                                                                                  ✅                                                                                                   |\n\n## 🚀 Usage\n\n```bash\ndotload @username\ndotload @username/repo_name\ndotload https://github.com/username/dotfiles.git\n```\n\nWhere `username` is the **GitHub username** whose dotfiles you want to clone.\n\n`repo_name` - Name of your **dotfiles repository**, if not specified - `dotfiles` name will be used by default\n\nYou can also use URLs of repositories such as **GitLab**, **Codeberg**, etc.\n\n### Advanced Usage\n\n```bash\ndotload @username branch_name\n```\n\n\u003e [!TIP]\n\u003e You can also use `-b` or `--branch` flags:\n\n```bash\ndotload @\u003cusername\u003e [--branch branch_name | -b branch_name]\ndotload \u003crepo_url\u003e [--branch branch_name | -b branch_name]\n```\n\nWhere `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\n\n---\n\nUse the `--help` flag to get help:\n\n```bash\ndotload --help\n# Help page...\n```\n\n### Custom installation scripts\n\nYou can also add an installation script to your `dotfiles` repository to fully automate the installation and get more features\n\nThe installation file can have the following names and locations:\n\n-   _install.sh_\n-   _install_\n-   _bootstrap.sh_\n-   _bootstrap_\n-   _script/bootstrap_\n-   _setup.sh_\n-   _setup_\n-   _script/setup_\n\nIf 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.\n\n### Configuration\n\nYou can also **specify a custom installation script**\nor make it optional in `dotload.conf`, for this read the [**dotload.conf documentation**](docs/dotload_conf.md)\n\n## 🤝 Contributing\n\nContributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nYou can start developing on [**GitHub Codespaces**](https://github.com/features/codespaces) right away\n\n[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/cli-stuff/dotload?quickstart=1)\n\nOr use the usual method on your computer:\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\nPlease make sure to update tests as appropriate.\n\nAlso, please read our [**Code of Conduct**](CODE_OF_CONDUCT.md), and follow it in all your interactions with the project.\n\n## 📝 License\n\nThis project is [**MIT**](https://opensource.org/license/MIT) licensed.\n\nSee [**LICENSE**](LICENSE)\n\n## ❤️ Support\n\nIf you like this project, consider supporting it by starring ⭐ it on GitHub, sharing it with your friends, or [buying me a coffee ☕](https://github.com/cli-stuff/dotload?sponsor=1)\n","funding_links":["https://buymeacoffee.com/okinea","https://donatello.to/okineadev"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcli-stuff%2Fdotload","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcli-stuff%2Fdotload","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcli-stuff%2Fdotload/lists"}