mirror of https://github.com/oh-my-fish/oh-my-fish.git synced 2024-11-22 22:03:53 +08:00

The Fish Shell Framework

fish fishshell fishshell-framework hacktoberfest oh-my-fish oh-my-zsh omf prompt shell terminal

Go to file

Kevin Menard e6a0caf27a Add an example completion file.		2015-05-18 22:31:47 -04:00
custom	Add an example completion file.	2015-05-18 22:31:47 -04:00
functions	do not traverse completions directory	2015-02-19 02:22:57 -02:00
plugins	Modify README.md	2015-05-06 13:05:31 +02:00
script	test runner should search fish_path for specs instead of *	2015-01-21 13:03:35 +09:00
spec	import tests	2015-02-19 01:46:30 -02:00
templates	try plugin: quick theme switcher	2015-02-19 19:56:12 -02:00
themes	refact(scorphish): set colors on top of method to use them onwards	2015-05-11 21:52:12 -03:00
tools	Update install.fish	2015-01-24 18:37:56 -02:00
.editorconfig	Init root .editorconfig file.	2015-02-15 13:30:17 +08:00
.gitignore	Ignore ta plugin's data dir	2015-03-18 08:49:06 +09:00
.travis.yml	travis hook for gitter integration	2015-03-30 21:58:26 -03: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	Add installation note about config.fish	2015-04-30 12:46:10 -04:00

README.md

![](https://img.shields.io/badge/Framework-Oh My Fish-blue.svg?style=flat)

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

NOTE: The installation script renames your existing config.fish to config.orig, and replaces it with the default oh-my-fish config. If you have existing customizations to your fish config, you will need to manually include those customizations after the install.

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

Clone the repository

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

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

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

Start / restart fish (just open a new terminal)

Uninstall

rm -rf ~/.oh-my-fish

License

Logo by marcker🔹 Attribution CC 4.0