README.md

dotfiles

This is my personal configuration, I don't expect anyone else to use this, it is up here as reference.

I have a separate repository I push scripts up to with checks for dependencies to make them easier to install. That includes some cross-platform scripts which handle prompting for input/sending notifications etc. -- this repository is more application configuration files and personal scripts

This was originally linux-only, but over the months and years I've added a compatibility layer of sorts; A global ON_OS variable which uses on_machine to figure out which machine/operating system I'm on. (linux_arch, mac, android (termux) or windows (WSL)) is set on X server/terminal launch. The bootstrap scripts in .config/yadm dispatch against that to install different packages

In general:

• zsh, plugins/configuration handled manually in .config/zsh (split across multiple files)
• yadm to manage dotfiles, see yadm-with-README.md
• wezterm as terminal, alacritty on windows
• firefox-developer-edition - browser, addons listed in firefox_addons.txt
• neomutt for email
• nvim (with LSP, completion, the typical modern plugins, see .config/nvim)
• todotxt for todos, with a rofi-interface as GUI
• calcurse as a calendar, with some hooks to source other events. menu bar icon displays what I have going on today
• ranger - terminal file manager, with a few custom commands to integrate fzf, lots of additional bindings/an extensive preview script, a shell function so cding in ranger changes my shell directory

I use syncthing to sync my files/data across my computers.

On Arch/X11:

• i3-gaps - window manager; config file - i3-launcher reminds me of my bindings for my launcher mode
• rofi - application launcher
• i3lock for screen lock; daemon process caches pixelated version of screen to speed up start time
• dunst for notifications
• picom for window compositing
• i3blocks as a status bar

On Arch/Hyprland:

• rofi wayland fork
• waybar as a status bar
• kitty as a terminal (has better wayland support)

On Mac:

• Uses skhd as a hot-key daemon to run applications (e.g. cmd + opt + enter launches terminal)
• alfred as a application launcher

On Android (using Termux):

Not a ton of application-specific setup yet, handles setting up zsh, installs all my packages using apt; see android_bootstrap

On Windows (in WSL):

Similar to Termux, does an apt-based install. Installs a bunch of languages/programs manually if since the versions on apt are ancient. Should install yadm manually.

---

• .local/scripts/supervisor_jobs has jobs using supervisor to daemonize, so I dont have to write plists or systemd scripts, and background processes work mac, linux, and windows. That uses bgproc as an anacron replacement, and on_machine to figure out which jobs to run on each system/distribution
• ttt is sprinkled throughout lots of my scripts, it acts as an extension to my shell history, saving commands from i3 bindsyms, or ranger commands. Lets me cd to one of those directories quickly using fzf
• .config/yadm includes lists of global packages to install for pacman/apt/brew, python, ruby, node, dart, rust, go, elixir and bash
• .config/shortcuts.toml - describes basic shell scripts that are created by shortcuts
• lots of other stuff in here:
  • .local/scripts/generic
  • .local/scripts/linux
  • .local/scripts/cross-platform

For a summary of tools I use often, see here.

Install

# on mac, run `xcode-select --install`
yadm clone https://gitlab.com/purarue/dotfiles
# restart the computer so that ~/.profile and zsh is setup properly
# so OS detection can be done to install the correct packages
yadm bootstrap

LICENSE

Unless where specified, this is all licensed under MIT:

MIT License

Copyright (c) 2019 purarue

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.