Skip to content

nclsprsn/dotfiles

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

143 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dotfiles

These are my dotfiles. Take anything you want, but at your own risk.

Dependencies

Core

Package Description Module
Neovim Editor ($EDITOR / $VISUAL) -
Git Version control tools
delta Git pager (side-by-side diffs) tools
fzf Fuzzy finder (used in git aliases) tools
Jujutsu (jj) Alternative VCS tools

Shell (pick one)

Package Description Module
Zsh Primary shell zsh
Bash Fallback shell bash
Starship Cross-shell prompt (optional, disabled by default) ui
NVM Node version manager (optional) -

Desktop environment (Wayland)

Package Description Module
Hyprland Wayland compositor ui
Waybar Status bar ui
Wofi Application launcher ui
Hyprlock Lock screen ui
Swaybg Wallpaper (expects ~/wallpapers/bg.jpg) ui
Dunst Notification daemon tools
Cliphist Clipboard manager ui
wl-clipboard Wayland copy/paste (wl-copy, wl-paste) ui
Grim + Slurp Screenshots ui
pavucontrol PulseAudio volume control ui
hyprpolkitagent Polkit authentication agent ui
PCManFM File manager tools

Terminal & media

Package Description Module
Ghostty Terminal emulator tools
MPV Video player video
Superfile Terminal file explorer tools
htop Process monitor tools

Fonts & theming

Package Description
Geist Mono Primary font (+ Nerd Font variant)
JetBrainsMono Nerd Font UI font (Waybar, Wofi, Hyprlock)
Catppuccin Frappe Color scheme (GTK, Qt, Ghostty, Dunst, Starship)
Papirus-Dark Icon theme
Kvantum + qt6ct Qt theming

Usage

Install

git clone https://github.com/nclsprsn/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
cp config/config.sh.default config/config.sh
vim config/config.sh
./INSTALL.sh

The install script symlinks *.symlink files to your home directory and ~/.config/. Edit config/config.sh to set your OS, environment, user role, and excluded modules.

Configuration

In config/config.sh:

Option Values Description
DOTFILES_OS Arch, Debian Target distribution
DOTFILES_ENV Desktop, Server Environment type
DOTFILES_USER Admin, User, Root User role
DOTFILES_STARSHIP_ENABLED true, false Use Starship prompt
DOTFILES_EXCLUDE Module names Modules to skip during install

Available modules: zsh, bash, vim, ui, video, tools.

Note: The ui module (Hyprland, Waybar, etc.) ships with hardware-specific defaults (monitor layout, French AZERTY keyboard, AMD GPU env vars) that you will need to adapt to your own setup.

Uninstall

xargs rm -rf < ~/.dotfiles/.installed.list

And remove the ~/.dotfiles folder.

Screenshots

Screenshot desktop

Contributing to the dotfiles

You can discuss using the issues section. To contribute, create an issue, and send a pull request.

License

The dotfiles are available under the Beerware license.

About

Dotfiles 🐱

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages