oh-my-fish/README.textile

A handful of functions, auto-complete helpers, and stuff that makes you shout...


bq. "OH MY FISH!"

h2. Setup

@oh-my-fish@ should work with any release from "fish 2.0":http://ridiculousfish.com/shell/

h3. The automatic installer... (do you trust me?)

You can install this via the command line with either `curl` or `wget`.

h4. via `curl`

@curl -L https://github.com/bpinto/oh-my-fish/raw/master/tools/install.sh | sh@

h4. via `wget`

@wget --no-check-certificate https://github.com/bpinto/oh-my-fish/raw/master/tools/install.sh -O - | sh@

h3. The manual way


1. Clone the repository

@git clone git://github.com/bpinto/oh-my-fish.git ~/.oh-my-fish@

2. Create a new fish config by copying the fish template we've provided.

*NOTE*: If you already have a ~/.config/fish/config.fish file, you should back it up: @cp ~/.config/fish/config.{fish,orig}@ in case you want to go back to your original settings.

@cp ~/.oh-my-fish/templates/config.fish ~/.config/fish/config.fish@

3. Start / restart fish (open a new terminal is easy enough...)

h3. Set fish as your default shell

1. Add fish to the list of login shells

@grep -q '^/usr/local/bin/fish$' /etc/shells; or echo '/usr/local/bin/fish' | sudo tee -a /etc/shells@

2. Set fish as default shell

@chsh -s /usr/local/bin/fish@

h2. Usage

* enable the plugins you want in your @~/.config/fish/config.fish@ (take a look at @plugins/@ to see what's possible)
** example: @set fish_plugins autojump bundler@
* Theme support: Change the @fish_theme@ environment variable in @~/.config/fish/config.fish@.

h3. Customization

If you want to override any of the default behavior, just add a new file (ending in @.load@) into the @custom/@ directory.
If you have many functions which go well together you can put them as a *.fish file in the @custom/plugins/@ directory and then enable this plugin.
If you would like to override the functionality of a plugin distributed with oh-my-fish, create a plugin of the same name in the @custom/plugins/@ directory and it will be loaded instead of the one in @plugins/@.


h3. Uninstalling

If you want to uninstall it, just remove the installation folder @rm -r ~/.oh-my-fish@ from the command line and restore your previous fish config file.

h2. Help out!

I'm far from being a fish-expert and suspect there are many ways to improve. If you have ideas on how to make the configuration easier to maintain (and faster), don't hesitate to fork and send pull requests!

h3. Send us your theme!

I'm hoping to collect a bunch of themes for our command prompts. You can see existing ones in the @themes/@ directory.



h2. Oh My ZSH

This project is heavily inspired (cloned) on "oh-my-zsh":https://github.com/robbyrussell/oh-my-zsh/

Thank you so much!