Archives
/
oh-my-fish
mirror of https://github.com/oh-my-fish/oh-my-fish
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
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.
301 Commits
4 Branches
6 Tags
3.6 MiB
Shell 99.6%
C 0.3%
Dockerfile 0.1%
 
 
 
master
fix-confd
doctor-db
omf-install-tests
v7
v2
v3
v4
v5
v6
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '36abf97c9c'
${ noResults }
Go to file
Vincent Pretre 36abf97c9c Added exit code in right prompt 
Display name in red when user is root
 		11 years ago
custom fixing example custom load file format 12 years ago
functions source_script: Use command for external commands 11 years ago
plugins Corrected logic when testing if exists. 11 years ago
templates Revert "fish has renamed . to source" 11 years ago
themes Added exit code in right prompt 11 years ago
tools Use public HTTPS when installing Oh My Fish 11 years ago
.gitignore Ignore emacs temp files 11 years ago
README.markdown removing copy prompts function from readme 11 years ago
oh-my-fish.fish extracting _append_path function 11 years ago

README.markdown

Oh My Fish!

Why?

Developing on a shell should be a pleasure. Our goal is to help developers that don't 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, 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.sh | sh

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 plugins add this line set fish_plugins git rails to your configuration file.

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 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!

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

Switching to fish

If you wish to use fish as your default shell, use the following command:

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

chsh will prompt you for your password, and change your default shell.

To switch your default shell back, you can run:

chsh -s /bin/bash

Substitute /bin/bash with /bin/tcsh or /bin/zsh as appropriate.

Manual installation

  1. Clone the repository
    git clone git://github.com/bpinto/oh-my-fish.git ~/.oh-my-fish
  1. Create a new fish config by copying the fish template we've provided.
    cp ~/.oh-my-fish/templates/config.fish ~/.config/fish/config.fish
  1. Start / restart fish (just open a new terminal)

Uninstall

rm -rf ~/.oh-my-fish

###. Oh My ZSH

This project is heavily inspired by oh-my-zsh