# alien-minimal

**alien-minimal** theme is faster than many other themes.

**Why?** It updates part of the prompt asynchronously – the time-consuming processing like git status checking,
git dirty copy checking and so on

**How?** It starts a background job for these processes, and in the meantime shows initial prompt and lets you use the
terminal as you would normally.

**alien-minimal** is **independent** of any library/framework like Oh-My-Zsh or Prezto.

## Installation

Add the following line in `~/.zshrc` depending on zsh plugin manager

##### [antigen](https://github.com/zsh-users/antigen):

```zsh
antigen theme eendroroy/alien-minimal alien-minimal
```

##### [zgen](https://github.com/tarjoilija/zgen):

```zsh
zgen load eendroroy/alien-minimal
```

##### [zplug](https://github.com/zplug/zplug):

```zsh
zplug "eendroroy/alien-minimal"
```

##### [oh-my-zsh: Overriding and Adding Themes](https://github.com/robbyrussell/oh-my-zsh/wiki/Customization#overriding-and-adding-themes)

```zsh
# if using git 2.13 or higher
git clone --recurse-submodules https://github.com/eendroroy/alien-minimal.git ${ZSH_CUSTOM}/themes/alien-minimal

# if lower version use
cd ${ZSH_CUSTOM}/themes/alien-minimal
git clone https://github.com/eendroroy/alien-minimal.git
git submodule update --init --recursive # --remote
```

Then set `ZSH_THEME="alien-minimal/alien-minimal"` in the `~/.zshrc` file.

## Customizations

**add configurations in `~/.amrc`**

### Sections

#### Available sections:

- am_ssh_st
- am_prompt_start_tag
- am_prompt_dir
- am_prompt_end_tag
- am_venv
- am_version_prompt
- am_vcs_prompt
- am_space
- am_vi_prompt

#### `am_vcs_prompt` configuration

Git:

- am_git_symbol
- am_git_rebasing
- am_git_branch
- am_git_left_right_master
- am_git_commit_time
- am_git_rev
- am_git_stash
- am_git_left_right
- am_git_dirty

Mercurial:

- am_hg_symbol
- am_hg_branch
- am_hg_rev

Subversion:

- am_svn_symbol
- am_svn_rev

#### A sample sensible configuration

```zsh
AM_VERSIONS_PROMPT=()

AM_GIT_SECTION=(
  am_git_symbol
  am_git_rebasing
  am_git_branch
  am_git_left_right_master
  am_git_commit_time
  am_git_rev
  am_git_stash
  am_git_left_right
  am_git_dirty
)

AM_HG_SECTION=(
  am_hg_symbol
  am_hg_branch
  am_hg_rev
)

AM_SVN_SECTION=(
  am_svn_symbol
  am_svn_rev
)

AM_LEFT_SECTION=(
  am_space
  am_ssh_st
  am_prompt_start_tag
  am_prompt_dir
  am_prompt_end_tag
  am_venv
  am_space
)

AM_RIGHT_SECTION=(
  am_version_prompt
  am_vcs_prompt
)
```

### Update left prompt asynchronously

```zsh
export AM_ASYNC_L_PROMPT=1
```

### Show initial new line

Always show a new line

```zsh
export AM_INITIAL_LINE_FEED=1
```

Unset `AM_INITIAL_LINE_FEED` to stop printing a new line.

### Add start tag and end tag:

```zsh
export AM_PROMPT_START_TAG='-->'     # previously `PROMPT_START_TAG`     
export AM_PROMPT_END_TAG='\ $'       # previously `PROMPT_END_TAG`       
export AM_PROMPT_START_TAG_COLOR=81  # previously `PROMPT_START_TAG_COLOR`  
export AM_PROMPT_END_TAG_COLOR=81    # previously `PROMPT_END_TAG_COLOR`    
```

**Result:**

```zsh
--> ~ $
--> ~ $ 1
(venv) --> python-project $
(venv) --> python-project $ 130
```

You can additionally show the error color on prompt start tag:

```zsh
export AM_ERROR_ON_START_TAG=1
```

_Note: if `AM_PROMPT_START_TAG` is empty, this configuration will be ignored._

### Show versions:

Available version are:
`PYTHON`,`PYTHON_S`,`RUBY`,`RUBY_S`,`JAVA`,`JAVA_S`,`GO`,`GO_S`,`ELIXIR`,`ELIXIR_S`,
`CRYSTAL`,`CRYSTAL_S`,`NODE`,`NODE_S`,`PHP`,`PHP_S`,`GRADLE`,`MAVEN`

```zsh
export AM_VERSIONS_PROMPT=(RUBY PYTHON JAVA GO CRYSTAL NODE PHP ELIXIR GRADLE)
```

Customize Separator:

```zsh
export AM_VERSION_PROMPT_SEP='|'
```

_Note: Prompt maintain declaration order._

### Configure dirname in prompt:

```zsh
export AM_DIR_EXPANSION_LEVEL=2
```

### Hide exit code:

```zsh
export AM_HIDE_EXIT_CODE=1
```

### Keep previous RPROMPT:

```zsh
export AM_KEEP_PROMPT=1
```

### Color themes:

```zsh
1. export AM_THEME=mono
2. export AM_THEME=mono_bright
3. export AM_THEME=terminal
4. export AM_THEME=soft
5. export AM_THEME=default
```

_Note: **Unset `AM_THEME` to use default color scheme.**_

**Apart from these default themes, custom colors can be defined:**

Use [previewer](https://eendroroy.github.io/alien-minimal/previewer/) to easily preview colors.

```zsh
export AM_VCS_COLOR=1          # color for VCS (G: M: V:)
export AM_SSH_COLOR=11         # color for ssh indicator
export AM_VI_INSERT_COLOR=11   # color for vi insert mode indicator
export AM_VI_NORMAL_COLOR=11   # color for vi normal mode indicator
export AM_NORMAL_COLOR=12      # color for normal text
export AM_ERROR_COLOR=1        # color for ERROR
export AM_REV_COLOR=14         # color for VCS Revision number
export AM_BRANCH_COLOR=10      # color for VCS BRANCH name
export AM_LEFT_RIGHT_COLOR=3   # color for GIT Left-Right status
export AM_STASH_COLOR=3        # color for GIT stash count
export AM_BARE_COLOR=3         # color for GIT bare repo indicator
export AM_COMMIT_SINCE_COLOR=6 # color for last commit time
export AM_FADE_COLOR=8         # color for fade text color
export AM_VENV_COLOR=8         # color fir python virtual env text
export AM_PYTHON_COLOR=2       # color for python version text
export AM_RUBY_COLOR=1         # color for ruby version text
export AM_JAVA_COLOR=15        # color for java version text
export AM_TIMER_COLOR=14       # color for command execution time
```

Or creating a new theme file:

__/path/to/custom/theme.zsh__

```zsh
#!/usr/bin/env zsh

am_theme(){
  AM_VCS_COLOR=248
  AM_SSH_COLOR=143
  AM_VI_INSERT_COLOR=143
  AM_VI_NORMAL_COLOR=143
  AM_NORMAL_COLOR=39
  AM_ERROR_COLOR=208
  AM_REV_COLOR=248
  AM_BRANCH_COLOR=78
  AM_LEFT_RIGHT_COLOR=222
  AM_STASH_COLOR=222
  AM_BARE_COLOR=222
  AM_COMMIT_SINCE_COLOR=244
  AM_FADE_COLOR=242
  AM_VENV_COLOR=245
  AM_PYTHON_COLOR=40
  AM_RUBY_COLOR=196
  AM_JAVA_COLOR=178
  AM_GO_COLOR=81
  AM_ELIXIR_COLOR=81
  AM_CRYSTAL_COLOR=8
  AM_NODE_COLOR=2
  AM_PHP_COLOR=5
  AM_GRADLE_COLOR=2
  AM_MAVEN_COLOR=3
  AM_TIMER_COLOR=248
  AM_PROMPT_START_TAG_COLOR=39
  AM_PROMPT_END_TAG_COLOR=39
  AM_GIT_TRACKED_COLOR=78
  AM_GIT_UN_TRACKED_COLOR=208
  AM_LEFT_RIGHT_COLOR=252
}
```

Then activate the theme using:

```zsh
export AM_CUSTOM_THEME_PATH=/path/to/custom/theme.zsh
```

### Nerd Font:

**Nerd Font must be installed [nerd-fonts](https://github.com/ryanoasis/nerd-fonts)**

Enable Nerd Font

```zsh
export AM_USE_NERD_FONT=1 # previously `USE_NERD_FONT`
```

### customize symbols

```zsh
export AM_GIT_STASH_SYM='@'
export AM_GIT_BARE_SYM='☢'
export AM_GIT_SYM='G'
export AM_HG_SYM='H'
export AM_SVN_SYM='S'
export AM_SSH_SYM='[S]'
export AM_JAVA_SYM='JAVA:'
export AM_PY_SYM='PY:'
export AM_RB_SYM='RB:'
export AM_GO_SYM='GO:'
export AM_ELIXIR_SYM='EX:'
export AM_CRYSTAL_SYM='CR:'
export AM_NODE_SYM='⬡ '
export AM_PHP_SYM='PHP:'
export AM_GRADLE_SYM='GRADLE:'
export AM_MAVEN_SYM='MVN:'
export AM_GIT_REBASING_SYMBOL='⇋'
export AM_GIT_PUSH_SYM='↑'
export AM_GIT_PULL_SYM='↓'
export AM_LEFT_RIGHT_SEP='|'
export AM_VIM_INSERT_SYM='(i)'
export AM_VIM_NORMAL_SYM='(n)'
```

_Note: this overrides `AM_USE_NERD_FONT` configuration._

## Libraries Used

- ['zsh-async'](https://github.com/mafredri/zsh-async) by **[@mafredri](https://github.com/mafredri)**
- ['promptlib-zsh'](https://github.com/eendroroy/promptlib-zsh) by **[@eendroroy](https://github.com/eendroroy)**

## License

The project is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).