mirror of https://github.com/oh-my-fish/oh-my-fish synced 2024-11-03 15:40:32 +00:00

Go to file

Nicholas Maccharoli 342c6d9c0d Fixed typo in CONTRIBUTING.md		2015-07-07 02:47:51 +09:00
custom	Add an example completion file.	2015-05-18 22:31:47 -04:00
functions	ignore git folders	2015-05-31 17:02:08 +01:00
plugins	Fix outdated project information	2015-06-17 12:52:32 -03:00
script	test runner should search fish_path for specs instead of *	2015-01-21 13:03:35 +09:00
spec	Fix loading of custom plugin completions.	2015-05-18 22:32:42 -04:00
templates	new Plugin and Theme functions	2015-05-30 13:11:54 +01:00
themes	Add .gitignore placeholders for plugins, themes.	2015-05-31 09:38:59 -07:00
tools	Fix outdated project information	2015-06-17 12:52:32 -03:00
.editorconfig	Init root .editorconfig file.	2015-02-15 13:30:17 +08:00
.gitignore	move fish functions to omf plugin	2015-05-31 13:13:23 +01:00
.travis.yml	travis hook for gitter integration	2015-03-30 21:58:26 -03:00
CONTRIBUTING.md	Fixed typo in CONTRIBUTING.md	2015-07-07 02:47:51 +09:00
Dockerfile	Fix outdated project information	2015-06-17 12:52:32 -03:00
LICENSE	MIT License	2014-07-22 07:25:04 -03:00
oh-my-fish.fish	move fish functions to omf plugin	2015-05-31 13:13:23 +01:00
README.md	Updated link to theme switcher plugin	2015-06-17 20:52:32 -05: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

curl -L https://github.com/oh-my-fish/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, click here.

Usage

Open your fish configuration file ~/.config/fish/config.fish and specify the theme and the plugins you want to use. And then run omf install on your terminal to install them.

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.

Upgrading from previous version

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

Contributing

Create an issue linking to your repository and we will move it to the oh-my-fish organization.

Uninstall

rm -rf ~/.oh-my-fish

License

Logo by marcker🔹 Attribution CC 4.0