You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Go to file
Jorge Bucaran d0afa91c5f Merge pull request #437 from kiRach/master
Some improvements on robbyrussel theme
9 years ago
custom fixing example custom load file format 12 years ago
functions do not traverse completions directory 10 years ago
plugins Add emacs plugin (even more updated) 9 years ago
script test runner should search fish_path for specs instead of * 10 years ago
spec import tests 10 years ago
templates try plugin: quick theme switcher 10 years ago
themes Variable name changed to be more meaningful 9 years ago
tools Update install.fish 10 years ago
.editorconfig Init root .editorconfig file. 10 years ago
.gitignore Ignore ta plugin's data dir 9 years ago
.travis.yml travis hook for gitter integration 9 years ago
CONTRIBUTING.md Update CONTRIBUTING.md 10 years ago
Dockerfile seq call in getopts should specify negative step 10 years ago
LICENSE MIT License 10 years ago
README.md Simplifying about section 9 years ago
oh-my-fish.fish Subsequent tests should run if one test fails. 10 years ago

README.md

About | Installation | Usage | Contribute | Uninstall | License

Build Status ![](https://img.shields.io/badge/Framework-Oh My Fish-blue.svg?style=flat) Join the chat at https://gitter.im/bpinto/oh-my-fish

Oh My Fish!

Why?

Developing on a shell should be a pleasure. Our goal is to help developers that do not want to spend time configuring their own computer to spend time doing what they want.

How?

With the power of our community, we take the already awesome fish shell to another level by creating simple-to-use plugins and themes.

What?

Oh-my-fish is a user-friendly framework for managing your fish-shell configuration. It includes optional plugins (brew, git-flow, rails, python, node, etc) and themes.


## Installation

Oh-my-fish is built for recent versions of the fish shell, namely "fish 2.0".

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

If you want to install it manually, keep reading.

Usage

Enabling a new plugin or theme is as easy as it should be. Open your fish configuration file ~/.config/fish/config.fish and specify the theme and the plugins you want to use.

As an example, to enable rails and git-flow plugins add this line set fish_plugins git-flow rails to your configuration file.

Before setting down on a theme, you might want to have a go with all themes using our quick theme switcher by typing theme --help on your shell.

Customization

If you have many functions which go well together, you can create custom plugin in the custom/plugins/PLUGIN_NAME directory and add to it as many functions as you want.

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 shipped with oh-my-fish.

If you would like to use your custom theme, move it with the same name in the custom/themes/ directory and it will override the original theme in themes/.

If you just want to override any of the default behavior or add some environment variables, just add a new file (ending in .load) into the custom/ directory.

Send us your theme!

We are hoping to collect a bunch of themes for our command prompts. You can see existing ones in the themes directory.

Note: Theme authors, make sure to include a screenshot in your pull request.

Manual installation

  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.

    cp ~/.oh-my-fish/templates/config.fish ~/.config/fish/config.fish
    
  3. Start / restart fish (just open a new terminal)

Uninstall

rm -rf ~/.oh-my-fish

License

MIT © Contributors

Logo by marcker🔹 Attribution CC 4.0