Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/talal/mimir

Fast and minimal shell prompt
https://github.com/talal/mimir

bash git go kubernetes openstack prompt shell zsh

Last synced: about 1 month ago
JSON representation

Fast and minimal shell prompt

Awesome Lists containing this project

README 

        
# Archived project. No maintenance.



**What does this mean?** No further code will be committed and the repository

will remain in a read-only state.



**Why?** I no longer have the time to maintain this project.



Feel free to fork and make your own changes if needed :)



# Mímir



[![GitHub Release](https://img.shields.io/github/release/talal/mimir.svg?style=flat-square)](https://github.com/talal/mimir/releases/latest)

[![Build Status](https://img.shields.io/travis/talal/mimir/master.svg?style=flat-square)](https://travis-ci.org/talal/mimir)

[![Go Report Card](https://goreportcard.com/badge/github.com/talal/mimir?style=flat-square)](https://goreportcard.com/report/github.com/talal/mimir)

[![Software License](https://img.shields.io/github/license/talal/mimir.svg?style=flat-square)](LICENSE)



Mímir is a fast and minimal shell prompt written in [Go](https://golang.org).

The look of Mímir is inspired by [Pure](https://github.com/sindresorhus/pure)

and the functionality is inspired by

[prettyprompt](https://github.com/majewsky/gofu#prettyprompt).



[![asciicast](https://asciinema.org/a/225675.svg)](https://asciinema.org/a/225675)



The Mímir Go binary only displays the (pre) prompt line with all the

information. The actual prompt line used for input is configured in the shell's

config file. This allows for flexibility:

- You can configure the prompt line to your preference, e.g. you can specify a

  prompt symbol of your choice, add user or host name info, etc.

- You can use Mímir with any shell of your choosing. The description says Bash

  and Zsh because these are the shells which I have tested Mímir on but

  technically you can use Mímir with any shell as long as it allows you to load

  a binary as a prompt.



## Features



- It is very fast: loads under 5ms with everything turned on

  ([benchmark](https://asciinema.org/a/225680)).

- Shows current Git branch name.

- Long directory paths are shortened and inaccessible paths are highlighted in

  red.

- Kubernetes context and namespace info is shown using `KUBECONFIG` environment

  variable. If multiple config files are specified in the variable value then

  the first one with current context info is used. You can overwrite the K8s

  info by exporting the `CURRENT_KUBE_CTX` variable with an arbitrary value.

- OpenStack cloud info is shown using the standard OpenStack environment

  variables that begin with `OS_`. Variables that specify IDs are used if name

  specifying variables are not available. E.g. `OS_PROJECT_DOMAIN_ID` would be

  used if `OS_PROJECT_DOMAIN_NAME` is not available. You can overwrite the cloud

  info by exporting the `CURRENT_OS_CLOUD` variable with an arbitrary value.



## Installation



### Installer script



The simplest way to install Mímir on Linux or macOS is to run:



```

$ sh -c "$(curl -sL git.io/getmimir)"

```



This will put the binary in `/usr/local/bin/mimir`



### Pre-compiled binaries



Pre-compiled binaries for Linux and macOS are avaiable on the

[releases][releases] page.



[releases]: https://github.com/talal/mimir/releases



The binaries are static executables.



### Homebrew



```

$ brew install talal/tap/mimir

```



### Building from source



The only required build dependency is [Go](https://golang.org/) 1.11 or above.



```

$ git clone https://github.com/talal/mimir.git

$ cd mimir

$ make install

```



This will put the binary in `/usr/local/bin/mimir`



Alternatively, you can also build Mímir directly with the go get command without

manually cloning the repository:



```

$ go get -u github.com/talal/mimir

```



This will put the binary in `$GOPATH/bin/mimir`



## Usage



The following usage examples are just one example of how Mímir can be

configured. The examples below will result in a setup similar to the one shown

in the demo above: the prompt symbol (`❯`) changes to red if the previous

command exited with an error.



### Bash



Add this to your `.bashrc` file:



```bash

prompt_mimir_cmd() {

  if [ $? != 0 ]; then

    local prompt_symbol="\[\e[0;31m\]❯\[\e[0m\]"

  else

    local prompt_symbol="\[\e[0;35m\]❯\[\e[0m\]"

  fi



  PS1="$(/path/to/mimir)\n${prompt_symbol} "

}

PROMPT_COMMAND=prompt_mimir_cmd

```



### Zsh



Add this to your `.zshrc` file:



```zsh

autoload -Uz add-zsh-hook

prompt_mimir_cmd() { /path/to/mimir }

add-zsh-hook precmd prompt_mimir_cmd



prompt_symbol='❯'

PROMPT="%(?.%F{magenta}.%F{red})${prompt_symbol}%f "

```



### Options



| Option | Description | Usage |

| --- | --- | --- |

| `MIMIR_DISABLE_KUBE` | Disable Kubernetes context and namespace info. | `export MIMIR_DISABLE_KUBE=1` |

| `MIMIR_DISABLE_CLOUD` | Disable OpenStack cloud info. | `export MIMIR_DISABLE_CLOUD=1` |

| `CURRENT_KUBE_CTX` | Display arbitrary info for K8s. | `export CURRENT_KUBE_CTX='custom info'` |

| `CURRENT_OS_CLOUD` | Display arbitrary info for OpenStack. | `export CURRENT_OS_CLOUD='custom info'` |



## Credits



Most of the source code is borrowed from

[prettyprompt](https://github.com/majewsky/gofu#prettyprompt).