Go to file
bretello 86adb6f53a vim: ale lint on enter and auto poetry 2021-11-16 14:28:33 +01:00
ansible add ripgrep, remove ack 2021-10-01 17:34:36 +02:00
dev dev: update makefile with release target, update docs 2020-12-09 00:14:14 +01:00
ipython/profile_default update ipython config, add to install script 2020-11-22 16:51:48 +01:00
themes zsh: vim mode: show navigation indicator 2021-09-26 15:46:44 +02:00
vim vim: ale lint on enter and auto poetry 2021-11-16 14:28:33 +01:00
.git-blame-ignore-revs add git-blame-ignore-revs 2021-04-05 18:12:50 +02:00
.gitignore update selfupdate mechanism 2020-12-08 15:20:42 +01:00
README.md cleanup 2021-10-10 12:41:21 +02:00
aliases.zsh zsh: migrate sh -> zsh 2021-10-10 12:41:20 +02:00
antibody_plugins.txt zsh: disable slow loading plugins 2021-11-15 11:21:03 +01:00
brethil_dotfile.sh zsh: migrate sh -> zsh 2021-10-10 12:41:20 +02:00
check_for_update.zsh zsh: migrate sh -> zsh 2021-10-10 12:41:20 +02:00
colors.zsh zsh: migrate sh -> zsh 2021-10-10 12:41:20 +02:00
completion_style.zsh zsh: add completion style 2021-10-07 20:34:53 +02:00
functions.zsh cleanup 2021-10-10 12:41:21 +02:00
gitconfig git: add `git mylog` command 2021-10-10 12:41:21 +02:00
gitignore git: add global gitignore file 2021-01-09 23:41:47 +01:00
pdbrc.py [pdbrc] fix colorscheme 2021-10-23 15:19:48 +02:00
tmux.conf tmux: add join-pane/swap-window shortcuts 2021-10-01 17:34:37 +02:00
useful_commands New repo initial commit 2017-06-12 16:22:05 +02:00

README.md

brethil's dotfiles

A set of zsh dotfiles based on antibody and oh-my-zsh

Description

├── README.md
├──────── Main files ────────
│ ├── aliases.zsh
│ │     └── aliases definitions (sources `~/.dotfiles_aliases`)
│ ├── colors.zsh
│ │     └── ANSI color escapes
│ ├── functions.zsh
│ │     └── contains function definitions (sources `~/.dotfiles_functions`)
│ ├── ansible
│ │     └── ansible playboooks/config
│ └── brethil_dotfile.sh:
│       └── This file should be sourced by your `.zshrc`
├──────── antibody plugins ────────
│ ├── antibody_plugins_arch.txt
│ └── antibody_plugins.txt
├──────── oh-my-zsh themes ────────
│ ├── brethil.zsh-theme
│ └── brethil-minimal.zsh-theme
├──────── Misc rc files────────
│ ├── gitconfig
│ │     └── git configuration
│ ├── ipython
│ │     ├── profile_default
│ │     ├── ipython_config.py
│ │     ├── startup
│ │     ├── 11-autoreload.py
│ │     └── README
│ ├── vim
│ │    ├── vimrc
│ │    │ └── main vim rc
│ │    ├── plugs.vim
│ │    │ └── plugins to be installed with vim-plug
│ │    ├── plugins_config.vim
│ │    │ └── plugins configuration
│ │    ├── shortcuts.vim
│ │    │ └── vim shortcuts definitions
│ │    ├── functions.vim
│ │    │ └── miscellaneous vim function
│ │    └── twilight256.vim
│ │      └── an old colorscheme
│ └── pdbrc.py
│      └── pdb++ rc (a drop-in replacement for pdb)
├──────── Other ─────────────
├── check_for_update.sh
│      └── selfupdate script
└── useful_commands

Installation

  • With ansible:

    bash dev/add_community.general.sh # only if community.general is not installed
    ansible-playbook -v -i <hosts file> ansible/playbooks/setup.yml
    

    This playbook can be tested with a docker container

    Use -e fix_annoyances=true to fix some small annoyances (only run once)

  • Manually (this only installs the zsh configuration):

    git clone https://git.decapod.one/brethil/dotfiles ~/.dotfiles
    echo 'DOTFILES=~/.dotfiles' >> ~/.zshrc
    echo 'source $DOTFILES/brethil_dotfile.sh'
    

A self-update mechanism is included. It asks for confirmation to pull the latest changes from the git repo every two weeks. This also updates the git-sourced repositories installed by the install script. The self-update routine can be called manually by calling

dotfiles_selfupdate

If you do not want to run the installer script, you can just add source brethil_dotfile.sh in your .zshrc. This requires antibody installed.

Available Functions

  1. cheat: show cheat sheet for commands using cheat.sh (cheat <commandname>)

  2. Quickly edit/reload profile (esource/resource)

  3. dockertags list all tags for a given docker image

  4. color to print colored text (see 3. in the Misc section):

    color $Red "This will be printed in red"
    color $Yellow "This will be printed in red"
    
  5. git fixup (git-fixup) to create a fixup command and immediately rebase it

  6. Many more. Use list_functions to list defined functions and a small description

Files/Folders

  1. ~/bin, ~/git, ~/projects folders
  2. ssh config (~/.ssh/config):
    • Create ssh keys if not defined already
    • Keep connections alive by increasing timeout time
    • Include multiplexer to allow quick multiple connections to the same host
    • (Optional: Compression, this should allow more responsive shells with slow connections, but will slow things down when copying large files. My suggestion is to have compression enabled on a by-host basis in ~/.ssh/config)
  3. brethil.zsh-theme, brethil-minimal.zsh-themes, themes for oh-my-zsh.
  4. ~/.dotfiles_functions, ~/.dotfiles_aliases are sourced by this dotfiles, allowing for custom functions/aliases
  5. useful_commands contains a list of useful commands (the first rule of the tautology club...)

Misc

  1. Colored output (via grc) for several commands.

  2. Easy names for ANSI color escapes (Black, Red, Green, Yellow, Blue, Cyan, Purple, White, CLEAR), for example:

    echo -e "${Green}This text will be green${CLEAR}"
    

    will result in green text. Use $CLEAR to clear previous escape sequences add B before the variable (check colors.sh) name to use bold and U to underline (examples: $BRed, $UBlack for bold red and underlined black)

  3. Autoupdate script running every two weeks, autoupdate function: dotfiles_selfupdate (or git pull from $DOTFILESfolder)

  4. Automatic fix of theSSH_AUTH_SOCKenvironment variable:~/.ssh/rc is installed run on every ssh login, and updates a symlink pointing (~/.ssh/ssh_auth_sock). SSH_AUTH_SOCKpoints to this (set inbrethil_dotfile.sh). The idea is that if the user is logging in using ssh -A, and using tmux, it will be possible to use the remote socket over different sessions by always using the symlink.