Skip to content

clxrityy/dotfiles

Repository files navigation

~/.dotfiles/

A comprehensive repository containing all files and configurations to restore and reproduce my OS & development environment(s).

What are dotfiles?

User-specific application configuration is traditionally stored in so called dotfiles (files whose filename starts with a dot). It is common practice to track dotfiles with a version control system such as Git to keep track of changes and synchronize dotfiles across various hosts.


Operating systems

Each OS folder contains specific configurations, scripts, and installation instructions.

Note: shared shell configs and repo-wide config live outside OS folders:

  • shell/ (e.g. .bash_profile)
  • common/ (e.g. .editorconfig)
macOS Fedora
macOS Example Fedora Example

Scripts & Utilities

View all scripts/utilities and how to use them by running:

make help

Note: When using make to execute script-wrapper targets, pass arguments like:

make <target> ARGS="<args to pass to script>"

OR:

make <target> -- <args to pass to script>

Installation

Clone the repository

SSH (alternative)
Cloning with SSH requires that you have your SSH keys set up with GitHub.
See Connecting to GitHub with SSH for instructions
git clone [email protected]:clxrityy/dotfiles.git ~/.dotfiles
Using HTTPS (recommended for most users)
# Clone the repository (HTTPS)
git clone https://github.com/clxrityy/dotfiles.git ~/.dotfiles
# Navigate to the dotfiles directory
cd ~/.dotfiles

Run the installation script

# Show help
bash install.sh --help

# Run installation as a dry-run with verbose output
bash install.sh --dry-run --verbose

# Run installation (auto-detects OS, runs GNU Stow, then runs OS-specific steps)
bash install.sh

TO-DO

  • CI
  • Windows
  • Debian
  • Ventoy USB setup
  • Package migration script
  • Development-specific environments
  • VPN configurations
  • SSH config management
  • Container setups (Docker)

About

Files and configurations to restore and reproduce my OS & development environments

Topics

Resources

Stars

Watchers

Forks

Contributors

Languages