Skip to content

Latest commit

 

History

History
339 lines (233 loc) · 14.3 KB

README.md

File metadata and controls

339 lines (233 loc) · 14.3 KB

GitHub Release Date GitHub workflow status GitHub License Made with love GitHub Repo stars

Баннер

dotload

dotload - це простий, інтуїтивний та швидкий⚡ інструмент для встановлення конфігурацій (дотфайлів) та інших необхідних інструментів на будь-яку машину!

Встановлення · Повідомити про помилку · Запропонувати функцію

English Polish

ℹ️ Про проект

Screenshot Screenshot

dotload працює шляхом клонування репозиторію dotfiles з GitHub вказаного користувача

Цей інструмент було створено для того, щоб максимально спростити встановлення дотфайлів, необхідних інструментів для розробки (таких як nodejs, php, тощо.) та інших пакетів.

🤔 Як це працює?

Цей інструмент робить символічні посилання на ваші дотфайли з ~/.dotload в папку $HOME

Він також може робити символічні помилання на папки (разом з вкладеними файлами), назва яких починається на крапку, наприклад .configs

Warning

Дотфайли з ідентичними назвами безвідворотньо перезапишуться на нові з вашого репозиторію!

Наприклад якщо у вас на комп'ютері та у репозиторії є файл ~/.bashrc - то він перезапишеться новим з репозиторію. Перед тим як їх клонувати, переконайтесь що вони ваші, або ви зробили резервну копію попередніх конфігурацій

⚙️ Встановлення

Ви можете встановити dotload за допомогою цих пакетних менеджерів:

apt (PPA)

З цим методом ви отримуватимете подальші оновлення

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

За допомогою brew ви можете встановити цей інструмент на macOS (а також на Linux)

ℹ️ Примітка: Якщо у вас не встановлений brew, завантажте його прямо зараз за допомогою цієї команди:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

📥 Встановлення:

brew tap okineadev/dotload
brew install dotload
З install.sh (Рекомендовано) ✅

З цим методом, ви можете встановити dotload практично на будь-якій системі, в тому числі й на Termux

📥 Встановлення:

curl -sL https://cutt.ly/dotload-install | bash

🗑️ Видалення:

sudo rm $PREFIX/bin/dotload && hash -r

ℹ️ Примітка: Якщо ви хочете видалити цей інструмент з Termux, вам потрібно виконати вище вказану команду без sudo

З джерел (цього репозиторію)

З цим методом ви можете з легкістю модифікувати встановлення, та бути впевненим в безпеці.

Кроки для встановлення з джерел:

  1. Клонуйте репозиторій
git clone https://github.com/okineadev/dotload.git --depth=1
  1. Перейдіть в папку проекту
cd dotload
  1. Встановіть інструменти

Якщо у вас не встановлений make, вам потрібно його встановити:

sudo apt install make

Також наявна підтримка task.

📥 Встановлення:

make install

💡 Порада: якщо ви надаєте перевагу використанню сучаснішого task замість GNU make, можете скористатись цією командою:

task install

🗑️ Видалення:

make uninstall
# Або
task uninstall
Termux

З цим методом ви отримуватимете подальші оновлення

# Add Termux User Repository
pkg install tur-repo
pkg update && pkg install dotload

Також ви можете запустити його без встановлення на будь-якій ОС за допомогою цієї команди:

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

Таблиця сумісності

Linux logo
Linux
Termux logo
Termux
macOS logomacOS logo
macOS
Windows logo
Windows (on msys shell)

🚀 Використання

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

Де username - це ім'я користувача GitHub, чиї дотфайли ви хочете клонувати.

repo_name - Назва вашого репозиторію з дотфайлами, якщо не вказано - за замовчуванням буде використовуватись назва dotfiles

Warning

Ім'я користувача не може містити емодзі, пробіли або інші нестандартні символи

Розширене використання

dotload @username branch_name

Tip

Ви також можете використовувати прапорці -b або --branch:

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

Де branch_name - назва гілки сховища, яку ви хочете клонувати. Якщо не вказано, буде використано гілку за замовчуванням. Це може бути корисно, якщо у вас є кілька сценаріїв використання машини


Використовуйте прапорець --help для отримання довідки:

dotload --help
# Сторінка довідки...

Також наявна підтримка manpages:

man dotload

Кастомні скрипти встановлення

Ви також можете додати скрипт інсталяції до вашоро репозиторію dotfiles, щоб повністю автоматизувати встановлення та отримати більше можливостей

Інсталяційний файл може мати наступні назви та розташування:

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

Якщо жоден з цих файлів не знайдено, будь-які файли або папки у вибраному вами репозиторії dotfiles, що починаються з ., для них будуть створені символічні посилання в директорії $HOME.

Конфігурація

Ви також можете вказати власну назву скрипта інсталяції або зробити його необов'язковим у файлі dotload.conf, для цього прочитайте документацію по `dotload.conf

🛣️ Дорожня карта

  • Додати багатомовну підтримку README.md
    • 🇺🇦 Українська
    • 🇵🇱 Польська
    • 🇩🇪 Німецька
  • Написати інструкцію для розробників (по збірці пакету)
  • Переписати функцію створення deb-пакетів для підтримки різних версій Ubuntu - в процесі 🚧
  • Додати варіанти встановлення, такі як Snap, AUR, RPM
    • Snap
    • AUR
    • RPM

🤝 Внески

Внески - це те, що робить спільноту з відкритим вихідним кодом таким чудовим місцем для навчання, натхнення та творчості. Будь-який ваш внесок дуже цінний.

Ви можете моментально розпочати розробку в GitHub Codespaces

Open in GitHub Codespaces

Цей репозиторій містить ⚡prebuilds, які дозволяють пропустити встановлення пакетів і інструментів.

Або скористайтеся звичайним способом на комп’ютері:

  1. Форкніть проект
  2. Створіть гілку з вашими змінами (git checkout -b feature/AmazingFeature)
  3. Зафіксуйте ваші зміни (git commit -m 'Add some AmazingFeature')
  4. Надішліть зміни (git push origin feature/AmazingFeature)
  5. Відкрийте PR (Pull Request)

Будь ласка, переконайтеся, що ви оновили тести належним чином.

Також, будь ласка, прочитайте наш Кодекс поведінки і дотримуйтесь його у всіх ваших взаємодіях з проектом.

📝 Ліцензія

Цей проект ліцензію MIT.

Дивіться LICENSE

📨 Контакти

Telegram: @Okinea

❤️ Підтримка

Цей проект є повністю безкоштовним та з відкритим кодом. Якщо вам сподобався цей інструмент - я буду дуже вдячний, якщо ви зможете підтримати мене фінансово

Ось реквізити для переказів: