dotfiles

This was originally linux-only, but over the months and years I've added a compatability layer of sorts; A global ON_OS variable which has the current operating system (linux, mac, android (termux) or windows (WSL)) is set on X server/terminal launch. Lots of my scripts in cross-platform and the bootstrap scripts in .config/yadm dispatch against that to provide different functionality, e.g. send notifications, pick an item from a list (dmenu/rofi-like), prompt user for input etc...

I don't expect anyone to use this directly as its so personal, but hopefully you can pick and choose scripts and configuration that interests you for your own dotfiles

In general:

• zsh, plugins/configuration handled manually in .config/zsh (split across multiple files)
• yadm to manage dotfiles, see yadm-with-README.md
• kitty as terminal (with tmux), alacritty on windows
• firefox-developer-edition - browser, addons listed in firefox_addons.txt
• neomutt for email
• nvim (with nvim-cmp) and rarely (doom) emacs as editors - see editor
• todotxt for todos, with a rofi-interface as GUI
• 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:

• i3-gaps - window manager; config file - i3-notify-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 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, using:

sh <(curl -sSL http://git.io/sinister) -u 'https://github.com/TheLocehiliosan/yadm/raw/master/yadm'

• .local/scripts/supervisor has scripts/a config file for supervisor, so I dont have to write plists or systemd scripts, and background processes work on both mac and linux. That uses bgproc as an anacron replacement.
• 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, npm, dart, rust, go, elixir and bash
• .config/shortcuts.toml - describes basic shell scripts that are created by shortcuts
• .local/scripts/generic - lots of my scripts; e.g.
  • media related, mduration to get media length, gifme to convert video to gifs, lots of audio/video format conversion scripts
  • qr - create a QR code from a string and display it full screen
  • misspell-context - finds common spelling mistakes using misspell recursively, prompt me with the words in context so I can correct them

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

Install

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

LICENSE

Unless where attributed, any customization and scripts are licensed under the MIT License:

MIT License

Copyright (c) 2019-22 Sean Breckenridge

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.