README.md

   1 AX-ZSH: Alex' Modular ZSH Configuration
   2 =======================================
   3
   4 AX-ZSH is a modular configuration system for the Z shell. If provides sane
   5 defaults and is extendable by plugins.
   6
   7
   8 Installation
   9 ------------
  10
  11 To install AX-ZSH, call the `install.sh` script inside of the source directory.
  12 This script creates the `~/.axzsh` symbolic link to the source directory and
  13 creates links for `~/.zprofile`, `~/.zshrc`, `~/.zlogin`, and `~/.zlogout`
  14 (don't worry, already existing files are backed up).
  15
  16 Then you have to restart your ZSH session.
  17
  18
  19 Configuration
  20 -------------
  21
  22 AX-ZSH can be configured using settings in a `$HOME/.zshenv` file.
  23
  24 The following configuration variables are supported:
  25
  26 * `AXZSH_PLUGIN_D`: Optional directory for additional plugins.
  27 * `axzsh_default_plugins`: Array of default plugins, that will be loaded in
  28   addition to the core plugins. You can reset this array to disable(!) loading
  29   of these default plugins. Currently these plugins are loaded by default:
  30    * byebye
  31    * correction
  32    * grep
  33    * history
  34    * less
  35    * ls
  36    * prompt
  37    * ssh
  38    * std_aliases
  39    * std_env
  40    * std_options
  41 * `axzsh_plugins`: Optional array of addiutional (non-core and non-default)
  42   plugins to load.
  43
  44 Example for a `$HOME/.zshenv` file:
  45
  46 ```
  47 # Add additinal custom plugin search path
  48 export AXZSH_PLUGIN_D="/opt/ax-zsh-plugins"
  49
  50 # Disable all default plugins
  51 axzsh_default_plugins=()
  52
  53 # Add additional plugins
  54 axzsh_plugins=(
  55         editor_select
  56         homebrew
  57 )
  58 ```
  59
  60 Note: it should *not* be necessary to disable the default plugins! The above
  61 is an example only!
  62
  63
  64 Environment Variables
  65 ---------------------
  66
  67 Expected to be already set:
  68
  69 * `HOME`
  70 * `LOGNAME`
  71
  72 Validated and/or set up by core plugins:
  73
  74 * `AXZSH`
  75 * `HOST`
  76 * `HOSTNAME` (same as HOST, deprecated)
  77 * `LOCAL_HOME`
  78 * `PS1`
  79 * `SHORT_HOST`
  80 * `TERM`
  81 * `XDG_CACHE_HOME`
  82 * `ZSH_CACHE_DIR`