oh-my-fish_theme-bobthefish/README.md

98 lines
4.4 KiB
Markdown
Raw Normal View History

# bobthefish
2013-09-18 06:17:15 +00:00
2015-10-27 18:05:01 +00:00
`bobthefish` is a Powerline-style, Git-aware [fish][fish] theme optimized for awesome.
2013-09-18 06:17:15 +00:00
[![](https://img.shields.io/badge/Framework-Oh My Fish-blue.svg?style=flat)](https://github.com/oh-my-fish/oh-my-fish) ![](https://img.shields.io/cocoapods/l/AFNetworking.svg) [![Join the chat at https://gitter.im/oh-my-fish/oh-my-fish](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/oh-my-fish/oh-my-fish?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2013-09-18 06:17:15 +00:00
![bobthefish][screenshot]
### Installation
2015-10-24 17:37:25 +00:00
Be sure to have Oh My Fish installed. Then just:
2015-10-24 17:37:25 +00:00
omf install bobthefish
2013-09-18 06:17:15 +00:00
You will probably need a [Powerline-patched font][patching] for this to work.
[I recommend picking one of these][fonts]. For more advanced awesome, install a [nerd fonts patched font][nerd-fonts], and enable nerd fonts support:
set -g theme_nerd_fonts yes
2013-09-18 06:17:15 +00:00
This theme is based loosely on [agnoster][agnoster].
### Features
* A helpful, but not too distracting, greeting.
* A subtle timestamp hanging out off to the right.
* Powerline-style visual hotness.
* More colors than you know what to do with.
* An abbreviated path which doesn't abbreviate the name of the current project.
* All the things you need to know about Git in a glance.
* Visual indication that you can't write to the current directory.
### The Prompt
* Flags:
2015-11-22 15:55:11 +00:00
* Previous command failed (**`!`**)
* Background jobs (**`%`**)
* You currently have superpowers (**`$`**)
* Current vi mode
* _You'll need to `set -g theme_display_vi yes` to enable_
2015-07-19 23:30:24 +00:00
* `User@Host` (unless you're the default user)
* Current RVM or rbenv (Ruby) version
* Current virtualenv (Python) version
* _If you use virtualenv, you will probably need to disable the default virtualenv prompt, since it doesn't play nice with fish: `set -x VIRTUAL_ENV_DISABLE_PROMPT 1`_
2013-09-18 06:17:15 +00:00
* Abbreviated parent directory
2014-11-18 04:45:13 +00:00
* Current directory, or Git or Mercurial project name
* Current project's repo branch (<img width="16" alt="branch-glyph" src="https://cloud.githubusercontent.com/assets/53660/8768360/53ee9b58-2e32-11e5-9977-cee0063936fa.png"> master) or detached head (`➦` d0dfd9b)
2014-11-18 04:45:13 +00:00
* Git or Mercurial status, via colors and flags:
2015-11-22 15:55:11 +00:00
* Dirty working directory (**`*`**)
* Untracked files (**`…`**)
* Staged changes (**`~`**)
* Stashed changes (**`$`**)
* Unpulled commits (**`-`**)
* Unpushed commits (**`+`**)
* Unpulled _and_ unpushed commits (**`±`**)
2014-11-18 04:45:13 +00:00
* _Note that not all of these have been implemented for hg yet :)_
2013-09-18 06:17:15 +00:00
* Abbreviated project-relative path
### Configuration
2015-10-27 18:05:01 +00:00
You can override some of the following default options in your `config.fish`:
2015-07-19 23:30:24 +00:00
```fish
set -g theme_display_git no
set -g theme_display_git_untracked no
set -g theme_display_git_ahead_verbose yes
2015-12-16 18:12:21 +00:00
set -g theme_display_vagrant yes
2015-07-19 23:30:24 +00:00
set -g theme_display_hg yes
set -g theme_display_virtualenv no
set -g theme_display_ruby no
set -g theme_display_user yes
set -g theme_display_vi yes
set -g theme_display_vi_hide_mode default
set -g theme_title_display_process yes
set -g theme_title_display_path no
2015-10-27 18:05:01 +00:00
set -g theme_title_use_abbreviated_path no
set -g theme_date_format "+%a %H:%M"
set -g theme_avoid_ambiguous_glyphs yes
set -g theme_nerd_fonts yes
2015-07-19 23:30:24 +00:00
set -g default_user your_normal_user
```
2015-10-27 18:05:01 +00:00
**Title options**
- `theme_title_display_process`. By default theme doesn't show current process name in terminal title. If you want to show it, just set to `yes`.
- `theme_title_display_path`. Use `no` to hide current working directory from title.
- `theme_title_use_abbreviated_path`. Default is `yes`. This means your home directory will be displayed as `~` and `/usr/local` as `/u/local`. Set it to `no` if you prefer full paths in title.
**Prompt options**
- `theme_display_ruby`. Use `no` to completely hide all information about Ruby version. By default Ruby version displayed if there is the difference from default settings.
- `theme_display_vagrant`. This feature is disabled by default, use `yes` to display Vagrant status in your prompt. Please note that only the VirtualBox and VMWare providers are supported.
2015-10-27 18:05:01 +00:00
[fish]: https://github.com/fish-shell/fish-shell
2013-09-18 06:17:15 +00:00
[screenshot]: http://i.0x7f.us/bobthefish.png
[patching]: https://powerline.readthedocs.org/en/latest/fontpatching.html
[fonts]: https://github.com/Lokaltog/powerline-fonts
[nerd-fonts]: https://github.com/ryanoasis/nerd-fonts
[agnoster]: https://gist.github.com/agnoster/3712874