onboardme
OLD Dot Files for These files are no longer maintained but may be of use to someone :) Checkout jessebot/dot_files for my current dot files :)
These directories/files are installed to your home directory and follow the XDG Base Directory Spec as closely as possible.
Sections for each config directory/file
.config
hyper
File:
~/.config/hyper/.hyper.js
Sensible defaults for the hyper terminal emulator.
iterm2
iterm2 is a terminal emulator for macOS.
Symlinked File: [
~/.config/iterm2/Profiles.json -> ~/Library/Application\ Support/iTerm2/DynamicProfiles/Profiles.json
](Library/Application\ Support/iTerm2/DynamicProfiles/Profiles.json)Profiles.json
Sets some basic profiles:
- default - profile with spacechalk colorscheme,
- minimal - profile with basically nothing special and a plain
.bash_profile
.
karabiner
File:
~/.config/karabiner/karabiner.json
Config file for karabiner, which is used to map capslock to control on macOS and other key remapping that can be really useful.
kitty
Files:
Config files related to kitty, a terminal emulator. Cute open source kitty icon image by DinkDonk, as well as a basic
kitty.conf
to use some nerdfonts, and set up look and feel on macOS. I don't use this terminal emulator much anymore so I'm not sure how well this still works accross different OSes.
lsimg
File:
~/.config/lsimg/config.yaml
This is a local project that I'm working on to rewrite a bash script in python, to do basic checking of images in the terminal. I might remove it though, because after discovering [ranger], it might not be really needed 🤷
powerline
Configuration files for powerline, a status line for [BASH] and tmux. We enable a spacechalk color theme as well as:
- local IP address
- hostname
- current working directory
- git status info
- unread mail count
- kubernetes info
- laptop battery information
- the time
- status of last run command (only appears if exit code is not 0)
Currently working on getting mail notifications working.
Files for colors:
~/.config/powerline/colors.json
~/.config/powerline/colorschemes/default.json
~/.config/powerline/colorschemes/shell/default.json
Files for configuring powerline for a login shell, and the console shell:
~/.config/powerline/themes/shell/default.json
~/.config/powerline/themes/powerline.json
~/.config/powerline/themes/powerline_terminus.json
~/.config/powerline/themes/unicode_terminus.json
File for configuring tmux status line:
terminator
File:
~/.config/terminator
Default config for my favorite terminal from my starting days in tech, [terminator]. We set some basic spacechalk-esk colors, transparency, and mononoki fonts.
tmux
File:
~/.config/tmux/tmux.conf
Config file for tmux. Currently, it will:
- Sets 256 colors
- enable the powerline tmux status line
vim
Configuration for vim, a text editor, and it's plugins, installed via vim-plug. I am no longer actively using this vim configuration, and it will likely be archived soonish.
~/.config/vim/vimrc
is the main file for the global vim configuration. We set a lot of defaults, including:
- making vim use the XDG Base Directory Spec
- setting window width to 82 characters
- enabling line numbers
- enabling highlighting of column cursor is on
- add a colored column on column 80 for tidy python
- sets a nerd font for vim
- enable syntax highlighting
- use spacechalk colorscheme
- configure icons for VimDevicons, and NERDTree
- ale icons changed, ale linters and fixers set for python
- gitgutter icons
- folding defaults
- sets backups to XDG standard
- allow backspace in insert mode
- default tabbing
- set search history
- installs all the plugins here
- uses template files below
Auto-install vim-plug:
Files for syntax highlighting for python, ssh_known_hosts, and .toml files:
Files for default values in a python or markdown file:
Since we install the NERDTree plugin,
:NERDTreeToggle
enables a directory tree of your current directory on the left hand side of your current vim window.
.cron
local cron jobs for alarms, and package manager updates
.local
Directories:
bin
Files:
This is just where we throw a few really simple scripts like:
Command Description utc
for ease of use printing the time in UTC w3m-splits
open split in iterm2 and send a website or HTML file to w3m
w3m-splits
is mostly useful for [NeoMutt], but anything is possible 🤷Directories:
iterm2
Directory:
Everything in there are files written and provided by iTerm2 for integrating iterm2 magic into your terminal. The only custom one is the following:
Command Description it2split
Open split in iterm2 with your default profile
state
This directory and the directories/files within it are specifically to auto-generate directory structure so that XDG spec is enforced with tools that only loosely enforce it.
.zshrc
Recently started giving this some TLC, but still in it's infancy to be match the .bash configs. Currently we:
- set some useful aliases
- set the same powerline prompt as bash
Please feel free to fork this repo and make it your own.
You can still use onboardme
, but you'll want to pass in your git URL and branch. Example:
# this uses your personal git URL and makes sure to always pull from main
# if you want to overwrite your existing dot files, you can also add --overwrite to this command
onboardme --git_url https://github.com/your_username/dot_files --git_branch main