Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/agnoster/agnoster-zsh-theme

A ZSH theme designed to disclose information contextually, with a powerline aesthetic
https://github.com/agnoster/agnoster-zsh-theme

Last synced: 6 days ago
JSON representation

A ZSH theme designed to disclose information contextually, with a powerline aesthetic

Host: GitHub
URL: https://github.com/agnoster/agnoster-zsh-theme
Owner: agnoster
Created: 2015-07-21T19:34:01.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2023-01-23T10:33:26.000Z (almost 2 years ago)
Last Synced: 2024-11-29T01:06:08.805Z (13 days ago)
Language: Shell
Size: 5.93 MB
Stars: 4,020
Watchers: 42
Forks: 591
Open Issues: 82
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

awesome-hacking-lists - agnoster/agnoster-zsh-theme - A ZSH theme designed to disclose information contextually, with a powerline aesthetic (Shell)
awesome-starred - agnoster/agnoster-zsh-theme - A ZSH theme designed to disclose information contextually, with a powerline aesthetic (others)

README

        # agnoster.zsh-theme

A ZSH theme optimized for people who use:

- Solarized

- Git

- Unicode-compatible fonts and terminals (I use iTerm2 + Menlo)

For Mac users, I highly recommend iTerm 2 + Solarized Dark

# Compatibility

**NOTE:** In all likelihood, you will need to install a [Powerline-patched font](https://github.com/Lokaltog/powerline-fonts) for this theme to render correctly.

To test if your terminal and font support it, check that all the necessary characters are supported by copying the following command to your terminal: `echo "\ue0b0 \u00b1 \ue0a0 \u27a6 \u2718 \u26a1 \u2699"`. The result should look like this:

![Character Example](https://gist.githubusercontent.com/agnoster/3712874/raw/characters.png)

## What does it show?

- If the previous command failed (✘)

- User @ Hostname (if user is not DEFAULT_USER, which can then be set in your profile)

- Git status

  - Branch () or detached head (➦)

  - Current branch / SHA1 in detached head state

  - Dirty working directory (±, color change)

- Working directory

- Elevated (root) privileges (⚡)

![Screenshot](https://gist.githubusercontent.com/agnoster/3712874/raw/screenshot.png)

## Customize your prompt view

By default prompt has these segments: `prompt_status`, `prompt_context`, `prompt_virtualenv`, `prompt_dir`, `prompt_git`, `prompt_end` in that particular order.

If you want to add, change the order or remove some segments of the prompt, you can use array environment variable named `AGNOSTER_PROMPT_SEGMENTS`.

Examples:

- Show all segments of the prompt with indices:

```

echo "${(F)AGNOSTER_PROMPT_SEGMENTS[@]}" | cat -n

```

- Add the new segment of the prompt to the beginning:

```

AGNOSTER_PROMPT_SEGMENTS=("prompt_git" "${AGNOSTER_PROMPT_SEGMENTS[@]}")

```

- Add the new segment of the prompt to the end:

```

AGNOSTER_PROMPT_SEGMENTS+="prompt_end"

```

- Insert the new segment of the prompt = `PROMPT_SEGMENT_NAME` on the particular position = `PROMPT_SEGMENT_POSITION`:

```

PROMPT_SEGMENT_POSITION=5 PROMPT_SEGMENT_NAME="prompt_end";\

AGNOSTER_PROMPT_SEGMENTS=("${AGNOSTER_PROMPT_SEGMENTS[@]:0:$PROMPT_SEGMENT_POSITION-1}" "$PROMPT_SEGMENT_NAME" "${AGNOSTER_PROMPT_SEGMENTS[@]:$PROMPT_SEGMENT_POSITION-1}");\

unset PROMPT_SEGMENT_POSITION PROMPT_SEGMENT_NAME

```

- Swap segments 4th and 5th:

```

SWAP_SEGMENTS=(4 5);\

TMP_VAR="$AGNOSTER_PROMPT_SEGMENTS[$SWAP_SEGMENTS[1]]"; AGNOSTER_PROMPT_SEGMENTS[$SWAP_SEGMENTS[1]]="$AGNOSTER_PROMPT_SEGMENTS[$SWAP_SEGMENTS[2]]"; AGNOSTER_PROMPT_SEGMENTS[$SWAP_SEGMENTS[2]]="$TMP_VAR"

unset SWAP_SEGMENTS TMP_VAR

```

- Remove the 5th segment:

```

AGNOSTER_PROMPT_SEGMENTS[5]=

```

A small demo of the dummy custom prompt segment, which has been created with help of the built-in `prompt_segment()` function from Agnoster theme:

```

# prompt_segment() - Takes two arguments, background and foreground.

# Both can be omitted, rendering default background/foreground.

customize_agnoster() {

  prompt_segment 'red' '' ' ⚙ ⚡⚡⚡ ⚙  '

}

```

![Customization demo](https://github.com/apodkutin/agnoster-zsh-theme/raw/customize-prompt/agnoster_customization.gif)

## Future Work

I don't want to clutter it up too much, but I am toying with the idea of adding RVM (ruby version) and n (node.js version) display.

It's currently hideously slow, especially inside a git repo. I guess it's not overly so for comparable themes, but it bugs me, and I'd love to hear ideas about how to improve the performance.

Would be nice for the code to be a bit more sane and re-usable. Something to easily append a section with a given FG/BG, and add the correct opening and closing.

Also the dependency on a powerline-patched font is regrettable, but there's really no way to get that effect without it. Ideally there would be a way to check for compatibility, or maybe even fall back to one of the similar unicode glyphs.