README.md

   1 # Alex' "Oh My ZSH" Extensions
   2
   3
   4 ## Prerequisites
   5
   6 1. You must be using ZSH and
   7 2. ["OhMyZsh"](https://github.com/robbyrussell/oh-my-zsh) must be installed
   8    and set up properly.
   9
  10
  11 ## Installation
  12
  13 1. Download and copy the "OhMyZshExtensions" directory anywhere to the local
  14    system, or even better, clone the project using Git.
  15 2. Set up the `ZSH_CUSTOM` variable in your `$HOME/.zshrc` file to correctly
  16    point to the "OhMyZshExtensions" directory.
  17 3. Add the desired plugins the the `plugins` array in your `$HOME/.zshrc` file.
  18
  19
  20 ## Plugins
  21
  22 ### 0_console (*recommended*)
  23
  24 Use `tset` to make sure that `$TERM` is set to a valid value.
  25
  26 ### 1_local (*required*)
  27
  28 Try to create a "local" home directory (which is local to the current
  29 system and not stored on NFS, for example), set `$LOCAL_HOME` accordingly,
  30 set `XDG_CACHE_HOME`, and add user-local path names to `$PATH`.
  31
  32 ### 5_dev_env
  33
  34 Use a SSH wrapper script for Git (when available) and setup Python Pip
  35 environment (`$PIP_REQUIRE_VIRTUALENV`, `$PIP_DOWNLOAD_CACHE`, `$WORKON_HOME`,
  36 and `$PROJECT_HOME`).
  37
  38 ### accounting
  39
  40 Setup to aliases for `last`: `lasth` (show only one page of `head` output) and
  41 `lastf` (show only "foreign" logins).
  42
  43 ### boot2docker
  44
  45 Initialize environment for `boot2docker`, including `$DOCKER_HOST_IPA`. Requires
  46 a running boot2docker VM.
  47
  48 ### ccache
  49
  50 Setup `ccache` environment (`$CCACHE_DIR`), search for `ccache` wrapper scripts,
  51 and adjust `$PATH` accordingly.
  52
  53 ### editor_select
  54
  55 Automatically setup `$EDITOR` with the *best* editor found on the system. Search
  56 order is: atom, mate, subl, vim, vi.
  57
  58 ### keychain
  59
  60 Setup SSH and GnuPG agents using `keychain`.
  61
  62 ### reminders
  63
  64 Show reminds in the console using `iCalBuddy` (OS X) or `remind`. Reminders
  65 aren't shown more often than once every hour.
  66
  67 ### ssh
  68
  69 Define three aliases for SSH:
  70
  71 - Enfoce "StrictHostKeyChecking yes" for `ssh`,
  72 - Disable "StrictHostKeyChecking" for `sshnew` to add new hosts,
  73 - and define `sshtmp` to temporarily disable "StrictHostKeyChecking"
  74   and to bypass the `known_hosts` file.
  75
  76 ### thefuck
  77
  78 Alias `fuck` to correct the last entered command using `thefuck`.
  79
  80 ### z9_local_conf
  81
  82 Read in system-local configuration form `/var/lib/$HOSTNAME/zshrc`, when
  83 available.