Plugin

afx's goal is to finally support to install packages as command, plugin or both. In afx, several pacakge types (e.g. github) are supported but you can specify command and plugin field in all of sources.

Parameters

sources

Type	Default
list	(required)

sources allows you to select what to load files when starting shell.

Case 1Case 2Case 3

Simple case, just register to init.sh as load scripts

github:
- name: b4b4r07/enhancd
  description: A next-generation cd command with your interactive filter
  owner: b4b4r07
  repo: enhancd
  plugin:
    env:
      ENHANCD_FILTER: fzf --height 25% --reverse --ansi:fzy
    sources:
    - init.sh

Using wildcards to register multiple files

github:
- name: b4b4r07/zsh-prompt-minimal
  description: Super super super minimal prompt for zsh
  owner: b4b4r07
  repo: zsh-prompt-minimal
  plugin:
    env:
      PROMPT_PATH_STYLE: minimal
      PROMPT_USE_VIM_MODE: true
    sources:
    - '*.zsh-theme'

Filenames starting with numbers

local:
- name: zsh
  directory: ~/.zsh
  plugin:
    sources:
    - '[0-9]*.zsh'

env

Type	Default
map	{}

env allows you to set environment variables. By having this section in same YAML file of package declaration, you can manage it with same file. When we don't have afx, we should have environment variables in shell config (e.g. zshrc) even if not installed it yet or failed to install it. But thanks to afx, afx users can keep it with same files and enable it only while a package is installed.

Needs to login new shell

To enable environment variables to your shell, you need to run this command or start new shell after adding this command to your shel config (e.g. .zshrc):

source <(afx init)

Case 1

github:
- name: b4b4r07/zsh-prompt-minimal
  description: Super super super minimal prompt for zsh
  owner: b4b4r07
  repo: zsh-prompt-minimal
  plugin:
    env:
      PROMPT_PATH_STYLE: minimal
      PROMPT_USE_VIM_MODE: true
    sources:
    - '*.zsh-theme'

snippet

Type	Default
string	""

snippet allows you to specify the command which are runned when starting new shell.

Case 1

Login message if tpm is installed

github:
- name: b4b4r07/enhancd
  description: A next-generation cd command with your interactive filter
  owner: b4b4r07
  repo: enhancd
  plugin:
    env:
      ENHANCD_FILTER: fzf --height 25% --reverse --ansi:fzy
    sources:
    - init.sh
    snippet: |
      echo "enhancd is enabled, cd command is overrided by enhancd"
      echo "see github.com/b4b4r07/enhancd"

snippet-prepare (beta)

Type	Default
string	""

snippet-prepare allows you to specify the command which are runned when starting new shell. Unlike snippet, this snippet-prepare is run before source command.

1. Run snippet-prepare
2. Load sources
3. Run snippet

This option comes from #6.

Case 1

Run snippet before sources

github:
- name: sindresorhus/pure
  description: Pretty, minimal and fast ZSH prompt
  owner: sindresorhus
  repo: pure
  plugin:
    snippet-prepare: |
      zstyle :prompt:pure:git:branch color magenta
      zstyle :prompt:pure:git:branch:cached color yellow
      zstyle :prompt:pure:git:dirty color 091
      zstyle :prompt:pure:user color blue
      zstyle :prompt:pure:host color blue
    sources:
    - pure.zsh

if

Type	Default
string	""

if allows you to specify the condition to load packages. If it returns true, then the plugin will be loaded. But if it returns false, the plugin will not be loaded.

In if field, you can write shell scripts¹. The exit code finally returned from that shell script is used to determine whether it loads plugin or not.

Case 1

if login shell is zsh, plugin will be loaded

local:
- name: zsh
  directory: ~/.zsh
  plugin:
    if: |
      [[ $SHELL == *zsh* ]]
    sources:
    - '[0-9]*.zsh'

---

1. You can configure your favorite shell to evaluate if field by setting AFX_SHELL. ↩