dotbot-readme.md

⚠️ Dotbot is no longer being used. Replaced with ansible. check README.md ⚠️

dotfiles using dotbot

my configs, settings, installation scripts, etc

Quick start

git clone https://github.com/clumsy-coder/dotfiles && cd dotfiles

Profile installations

Run a dotbot profile script from dotfiles/meta/profiles/ folder

Available profiles

./install-profile <profile ...>

Ex:

./install-profile debian-terminal debian-gui # debian terminal and gui configs

---

MacOS

./install-profile macos # MacOS ONLY

Debian

./install-profile debian-terminal # Terminal configs ONLY

./install-profile debian-gui # Gui configs ONLY

Fedora

./install-profile fedora-terminal # Terminal configs ONLY

./install-profile fedora-gui # Gui configs ONLY

Raspberry Pi (Pi-hole)

./install-profile raspberrypi-pihole # Raspberry Pi terminal ONLY

---

Indivdual config installations

Run indivdual configs from dotfiles/meta/configs folder.

Availble configs

NOTE: leave out file extensions

Running a single config

./install-standalone <config>

Example:

./install-standalone spacevim

Running a config with sudo

NOTE: to run a config as sudo, append -sudo to the config being used

./install-standalone <config>-sudo

Example:

./install-standalone apt-sudo

Running multiple configs

./install-standalone <config> <config> <config> ...

Example:

./install-standalone spacevim apt-sudo alacritty

---

How does it work?

dotbot is used to bootstrap and setup dotfiles.

This can be used for installing packages, linking config files, creating folder, etc.

All dotbot files are located in meta/ folder

install-standalone script is used to run a config from dotfiles/meta/configs/ folder.

Check meta/configs/ for more details

install-profile script is used to run a collection configs (from dotfiles/meta/configs/) defined as profiles in dotfiles/meta/profiles/

Check meta/profiles/ for more details

---

File/Folder structure

dotfiles/
├── .github/
├── meta/
├── tools/
├── .gitignore
├── .gitmodules
├── .releaserc.js
├── CHANGELOG.md
├── install-profile
├── install-standalone
├── LICENSE
├── package.json
├── README.md
└── yarn.lock

.github/

Github CI files

Check .github/

meta/

Contains all dotbot files

Check meta/

tools/

Contains all application configs.

Check tools/

.gitmodules

Contains all git submodules for this repo

.releaserc.js

Used by npm package semantic-release

CHANGELOG.md

Changlog generated by semantic-release-bot

install-standalone

dotbot script used for running a config located in dotfiles/meta/configs/.

Check meta/configs/

Script obtained from: dotbot-template/install-standalone

It also loads XDG env set in tools/zsh/.zshenv. These XDG env direct where to store application data on the users HOME directory.

Check https://wiki.archlinux.org/title/XDG_Base_Directory

install-profile

dotbot script used for running a collection of dotbot configs.

Script obtained from: dotbot-template/install-profile

Check meta/profiles/

package.json

Contains npm packages for running semantic-release

---

Inspiration

• Dotfiles in 100 seconds by Firship
  • eieioxyz/dotfiles_macos Brief intro to Dotbot
• anishathalye/dotbot A tool that bootstraps your dotfiles ⚡️
• ecarlson94/userspace Build dev container using dotfiles
• ecarlson94/dotbot-template Template repository for advanced Dotbot setup
• ecarlson94/dotfiles ecarlson94's dotfiles and machine setup scripts.

---