Zsh — autoload First Steps

@ZSH.md

Zsh — autoload First Steps

What is autoload?

• Add file in specified directory and enable to use command.
  • Shell function behaves like command.
• Command name and file name is pair.

Make autoload directory

mkdir -p "$HOME/.zsh/autoload"

Any path you like.

Add directory to $FPATH

export FPATH="$HOME/.zsh/autoload/:$FPATH"

Add file in autoload directory

echo "echo hello zsh autoload" > "$HOME/.zsh/autoload/hello-zsh-autoload"

• File name will be command name.
• No need excutable permission.
• No need define function in file.

Add new command by autoload

autoload -U hello-zsh-autoload

Now you can hit new command

$ hello-zsh-autoload
hello zsh autoload

Confirm

You can see a new command hello-zsh-autoload was created as function by automatic.

$ which hello-zsh-autoload

hello-zsh-autoload () {
	echo hello zsh autoload
}

Examole. Add to .zshrc

export FPATH="$HOME/.zsh/autoload/:$FPATH"
autoload -U hello-zsh-autoload

Anytime you can use autoloaded command.

Versions

• zsh 5.5.1 (x86_64-apple-darwin17.5.0)

Links

• Qiita—Japanese
• Medium—imported

autoload.zsh

#!/usr/bin/env zsh -eu

# Usage
# $ zsh autoload.zsh
# or
# $ source autoload.zsh
# $ hello-zsh-autoload

tmp_dir="$HOME/tmp/autoload"

mkdir -p "$tmp_dir"

export FPATH="$tmp_dir:$FPATH"

echo "echo hello zsh autoload" > "$tmp_dir/hello-zsh-autoload"

autoload -U hello-zsh-autoload

hello-zsh-autoload