github-mirror/oh-my-fish
2
0
Fork 0
mirror of https://github.com/oh-my-fish/oh-my-fish.git synced 2024-11-24 16:45:48 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
The Fish Shell Framework
323 Commits 4 Branches 6 Tags 3.7 MiB
Shell 99.6%
C 0.3%
Dockerfile 0.1%
56ba9dbf7d
Go to file
Felipe Rodrigues de Almeida 56ba9dbf7d Added screenshot to the readme file.
2014-04-16 17:27:30 -03:00
custom fixing example custom load file format 2013-02-07 09:31:59 -02:00
functions source_script: Use command for external commands 2014-03-16 16:24:12 +01:00
plugins add README file with list of plugins and their short descriptions 2014-04-15 13:46:36 +01:00
templates Revert "fish has renamed . to source" 2013-10-18 14:15:47 -03:00
themes Added screenshot to the readme file. 2014-04-16 17:27:30 -03:00
tools Rewrite installation script in fish shell. 2014-04-04 18:20:29 +02:00
.gitignore Gitignore: Ignore vim backup file (sw?). 2014-04-16 21:43:33 +02:00
oh-my-fish.fish extracting _append_path function 2013-11-20 07:35:31 -02:00
README.markdown Update README with custom themes 2014-04-16 22:01:38 +02:00

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

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