1 AX-ZSH: Alex' Modular ZSH Configuration
2 =======================================
4 AX-ZSH is a modular configuration system for the Z shell (ZSH).
5 It provides sane defaults and is extendable by plugins.
10 To install AX-ZSH, either download a source archive or use Git to clone it.
11 Afterwards use the `install.sh` script inside of the source directory to set
12 up the `~/.axzsh` directory.
14 When using Git it is best to directly clone the AX-ZSH repository into the
15 `~/.axzsh` directory and call `install.sh` from this location.
17 Clone repository from _GitHub_ (<https://github.com/alexbarton/ax-zsh>):
19 git clone https://github.com/alexbarton/ax-zsh.git ~/.axzsh
21 Then run the installer script:
25 The `install.sh` script creates symbolic links for `~/.zprofile`, `~/.zshrc`,
26 `~/.zlogin`, and `~/.zlogout` (don't worry, already existing files are backed
29 Now close and restart all your running ZSH session to activate AX-ZSH.
31 To update AX-ZSH run `axzshctl upgrade`.
33 AX-ZSH & Local ZSH Configuration
34 --------------------------------
36 Plugins are loaded when they are linked into the `$AXZSH/active_plugins/`
37 directory; see the _Customization_ section below for how to activate them.
39 Don't modify `~/.zprofile`, `~/.zshrc`, `~/.zlogin`, or `~/.zlogout`! These
40 are links to "AX-ZSH"-private files that can become overwritten when updating.
42 You can use the following files for local ZSH configuration:
44 1. AX-ZSH doesn't use `~/.zshenv` in any way. So you can use this file for your
45 own purposes (for example, to set up some environment variables that AX-ZSH
48 2. AX-ZSH reads the optional files `~/.zprofile.local`, `~/.zshrc.local`,
49 `~/.zlogin.local`, and `~/.zlogout.local` after its own core initialization
55 Use the `axzshctl` tool to enable, disable, and reset plugins. AXZSH
56 initializes an alias which points to the actual location in `~/.axzsh/bin/`.
58 See `axzshctl --help` for details.
60 You can link custom plugins stored in arbitrary directories using `axzshctl`
61 by specifying the complete path name. Or you can place additional plugins into
62 the `~/.axzsh/custom_plugins` folder which is searched by the `axzshctl` tool
65 In addition you can set the `AXZSH_PLUGIN_D` variable (and `ZSH_CUSTOM` like
66 "OhMyZsh") to specify additional plugin search directories.
71 Expected to be already set:
76 Validated and/or set up by core plugins:
80 * `HOSTNAME` (same as HOST, deprecated)
85 * `TMPDIR` (set and always ends with a "/")