seanbreckenridge/dotfiles

my dotfiles/scripts; cross-platform (linux (arch), macos, android (termux), windows (WSL))

dotfiles

I have a separate repository (seanb-utils) I sync 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, using:

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

---

• .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/seanbreckenridge/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 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.

dotfiles's Issues

only load yadm-git if yadm is available

tmuxp for daemon events on macos

instead of fiddling with macos-specific daemon processes, just use a tmuxp config file to launch background processes otherwise handled by i3 on linux

add examples for frink

find something like pipx for npm?

add otter

https://github.com/jmbuhr/otter.nvim

try zsweep

https://github.com/psprint/zsh-sweep/tree/master

replace gitgutter with gitsigns.nvim

clippaste on windows?

add neoformat

remove try/except from ipython histaccessor

either remove altogether or increase the warning level so it prints to upgrade ipython version

nvim trouble v3 config updates

markdown preview

https://github.com/toppair/peek.nvim

switch to using yarn for global installs

add neogit

https://github.com/NeogitOrg/neogit

switch from alacritty to kitty

not super opinionated about either, but ueberzug (for ranger previews) hasnt been working in alacritty for months now, and works fine in kitty

nvim plugins

• https://github.com/rcarriga/nvim-notify
• https://github.com/liuchengxu/vista.vim or https://github.com/stevearc/aerial.nvim (dont know if I actually want one of these)
• https://github.com/gelguy/wilder.nvim
• https://github.com/stevearc/oil.nvim
• https://github.com/pwntester/octo.nvim
• (requires v0.10) https://github.com/Bekaboo/dropbar.nvim

nvim autopairs?

https://github.com/windwp/nvim-autopairs

ufo

https://github.com/kevinhwang91/nvim-ufo

nvim: injected language formatters

replace speeddatting plugin

https://github.com/monaqa/dial.nvim

create a minimal vim-unimpaired fork that is just what I use

pipx lowercase when checking for installed venvs

try setting up vim.keymap.set

nvim diffview

https://github.com/sindrets/diffview.nvim

lazy disable some rtp plugins

add ccc.nvim

https://github.com/uga-rosa/ccc.nvim

split ON_OS into its own repo?

feel like it clutters stuff here -- could create something else which has

ON_OS
ON_OS_PROC

Could do something like this https://pastebin.com/J66Lj6wf

could also then shell out like on_os mac in if checks, which allows this to handle errors/warn that that variable isnt set/sourced properly

make colorschemes globally editable through a script (dark/light)

mostly so its easier to work outside

replace neoformat with ftplugin files

https://github.com/tjdevries/config_manager/tree/master/xdg_config/nvim/after/ftplugin

For prettier, use
https://github.com/prettier/vim-prettier

or could do this
https://github.com/sbdchd/neoformat/blob/master/autoload/neoformat/formatters/typescript.vim

setup bindings for flameshot

https://github.com/flameshot-org/flameshot

setup luasnippets

formatter.nvim

https://github.com/mhartington/formatter.nvim

replace dunk

https://github.com/dandavison/delta

wayland/hyprland config

to do

• actually use i3-gaps (gaps)
• zsh theme?
• complicated PS1?
• rofi shortcuts/styling (or maybe switch to something else?)
• antigen/prezto?
• additional vimrc configuration
• ranger/lf
• i3blocks
• grub styling
• lightdm styling
• backups
• lock screen/lock screen styling
• dark mode default apps/CLI everything
• look up which daemons to autostart
• mpd? music player?
• subscribe to arch RSS for broken package updates
• create a description of what I'm using on the README

As reference for a more "complete" dotfiles repos:

https://github.com/maximbaz/dotfiles

https://github.com/jayywolff/dotfiles

add cmp-git

https://github.com/petertriho/cmp-git

https://github.com/b0o/nvim-conf/blob/98da2976d44e632510812886e7374769c246ca7d/lua/user/plugin/nvim-cmp.lua#L245-L365

tsp

look into https://manpages.ubuntu.com/manpages/xenial/man1/tsp.1.html

setup telescope

port mac and widows shkd bindings from alacritty to kitty

add dashboard

https://github.com/glepnir/dashboard-nvim

add installer for gh extensions

install nvim cloak plugin

migrate autotag nvim config

https://github.com/windwp/nvim-ts-autotag?tab=readme-ov-file#setup

replace j2cli with jinjanator

https://github.com/kpfleming/jinjanator

j2cli is unmantained

grab cool things from kickstart

https://github.com/nvim-lua/kickstart.nvim

script to update branches for python github CIs

send keystrokes from vim to tmux

pretty sure theres a plugin that does this somewhere?

enable inlay hints using LSP, add toggle

add vim-rhubarb

https://github.com/tpope/vim-rhubarb