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

https://github.com/lewis6991/fancy-prompt


https://github.com/lewis6991/fancy-prompt

Last synced: 7 months ago
JSON representation

Awesome Lists containing this project

README

          

# Features

* Provides a nice colourful prompt.
* Gives you basic information about your git checkout.
* Supports bash, csh and tcsh.
* Asynchronous! (zsh only)
* Rename Tmux windows to CWD
* OSC133 Support

# Screenshot

![img](screen.png)

# Installation

### Zsh

Requires mafredri/zsh-async.

#### Using [zimfw](https://github.com/zimfw/zimfw)

Add the following to your `.zimrc`:

```zsh
zmodule mafredri/zsh-async --name async
zmodule lewis6991/fancy-prompt
```

Then:

```zsh
zimfw install
```

#### Manually

Add the following to your `.zshrc`:
```zsh
source path/to/fancy_prompt/prompt.zsh

```

### Bash

```bash
./install.sh
```
Add the following to your `.bashrc`:
```bash
export PROMPT_COMMAND=__prompt_command

function __prompt_command() {
local exit_code=$?
PS1=$(~/.prompt bash $exit_code)
}
```

### Csh/Tcsh

```bash
./install.sh
```
Add the following to your `.cshrc`:
```csh
alias precmd 'set prompt="`~/.prompt csh $?`"'
```

# Customisation

### Timeout

```bash
FANCY_PROMPT_TIMEOUT=3
```
Timeout for commands fetching SCM updates.

### Symbols
```bash
FANCY_PROMPT_USE_SYMBOLS=1
```
Use powerline symbols. See [powerline/fonts](https://github.com/powerline/fonts).