github-mirror/oh-my-fish
2
0
Fork 0
mirror of https://github.com/oh-my-fish/oh-my-fish.git synced 2024-11-27 02:34:13 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
The Fish Shell Framework
751 Commits 4 Branches 6 Tags 3.7 MiB
Shell 99.6%
C 0.3%
Dockerfile 0.1%
3525b4fc61
Go to file
Bruno 3525b4fc61 Merge pull request #375 from Lavoaster/patch-1 
Fixed syl20bnr images in its readme
2015-02-12 16:58:23 -02:00
custom fixing example custom load file format 2013-02-07 09:31:59 -02:00
functions Do not add test/spec files to function path via skip glob in import. 2015-01-14 10:34:21 +09:00
plugins fix getopts: handle -h --help bug fish-shell#746 2015-02-12 00:20:56 +09:00
script test runner should search fish_path for specs instead of * 2015-01-21 13:03:35 +09:00
spec Closes #322: rename to-(not-)contain to to-(not-)contain-all 2015-01-17 13:32:19 -02:00
templates Update config.fish 2015-02-01 11:35:02 -02:00
themes Fixed syl20bnr images in its readme 2015-02-12 18:44:57 +00:00
tools Update install.fish 2015-01-24 18:37:56 -02:00
.gitignore Gitignore: Ignore vim backup file (sw?). 2014-04-16 21:43:33 +02:00
.travis.yml email notification settings 2015-01-19 12:58:50 -02:00
CONTRIBUTING.md Update CONTRIBUTING.md 2015-02-01 02:57:55 -02:00
Dockerfile seq call in getopts should specify negative step 2015-01-24 06:57:51 +09:00
LICENSE MIT License 2014-07-22 07:25:04 -03:00
oh-my-fish.fish Subsequent tests should run if one test fails. 2015-01-13 19:16:48 -02:00
README.md Update README.md 2015-02-01 03:10:30 -02:00

README.md

Oh My Fish!

Build Status

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