Skip to content
This repository has been archived by the owner on Apr 14, 2024. It is now read-only.

Latest commit

 

History

History
184 lines (126 loc) · 5.6 KB

README.md

File metadata and controls

184 lines (126 loc) · 5.6 KB
Raw

GitHub Release Date GitHub Actions Workflow Status GitHub Issues or Pull Requests GitHub License Made with love GitHub Repo stars

Banner

dotload

dotload - This is a simple, intuitive and fast⚡ tool for installing configurations (dotfiles) and other necessary tools on any machine!

Installation · Report Bug · Request Feature

Change language: 🇺🇦 UA

ℹ️ About the project

Screenshot

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, required development tools (such as nodejs, php, etc.) and other packages.

⚙️ Installation

You can install dotload using the following command:

sudo add-apt-repository ppa:salumin/tools
sudo apt update
sudo apt install dotload

Or you can run without installation on any OS with this command:

bash <(curl -sL t.ly/dotload) @<username>

More installation methods will be added soon

🚀 Usage

dotload @<username>

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

Warning

The username cannot contain emojis, spaces or other non-standard characters

Advanced Usage

dotload @<username> <branch_name>

Tip

You can also use -b or --branch flags:

dotload @<username> -b <branch_name>
# Or
dotload @<username> --branch <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...

There is also support for manpages:

man dotload

Custom installation scripts

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.

Configuration

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

🛣️ Roadmap

  • Solve the problem using the tool without installing (#2)
  • Add multilingual README.md support
    • 🇺🇦 Ukrainian
    • 🇵🇱 Polish
    • 🇩🇪 German
  • Write instructions for developers (package assembly)
  • Add installation options such as Snap, AUR, RPM
    • Snap - In progress 🚧
    • AUR
    • RPM

🤝 Contributing

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

  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.

📝 License

This project is MIT licensed.

See LICENSE

📨 Contact

Telegram: @Okinea

❤️ Support

This project is completely free and open source.

If you liked this tool - I would be very grateful if you could support me financially

Here are the details for transfers:

AI Generated

The code and content were partially generated by AI.