Archives/oh-my-fish
2
0
Fork 0
mirror of https://github.com/oh-my-fish/oh-my-fish synced 2024-11-15 12:12:45 +00:00
Code Issues Projects Releases Wiki Activity
1,130 Commits 4 Branches 6 Tags 3.7 MiB
Shell 99.6%
C 0.3%
Dockerfile 0.1%
e0c5f026de
Go to file
Derek Stavis e0c5f026de README: Use bundle in singular form
2015-09-07 00:12:02 -03:00
bin Back to oh-my-fish organization 2015-09-03 19:35:19 +01:00
db Add osx package 2015-09-03 23:35:26 -03:00
docs docs: Rewrite package creation example 2015-09-07 00:11:46 -03:00
lib Back to oh-my-fish organization 2015-09-03 19:35:19 +01:00
pkg/omf Back to oh-my-fish organization 2015-09-03 19:35:19 +01:00
templates Extracting template to a file and improving it 2015-08-28 12:53:37 +01:00
.editorconfig %%% United States of the Fish → Wahoo + OMF %%% 2015-08-27 00:20:13 +09:00
.gitignore fix omf new theme and remove default theme 2015-08-27 06:04:24 +09:00
.travis.yml %%% United States of the Fish → Wahoo + OMF %%% 2015-08-27 00:20:13 +09:00
CONTRIBUTING.md Back to oh-my-fish organization 2015-09-03 19:35:19 +01:00
init.fish Back to oh-my-fish organization 2015-09-03 19:35:19 +01:00
LICENSE Undo Licence.. because you know what happened here 2015-09-03 23:20:42 +01:00
README.md README: Use bundle in singular form 2015-09-07 00:12:02 -03:00

README.md

The Fishshell Framework

MIT License Fish Shell Version Travis Build Status Travis Build Status

Oh My Fish provides core infrastructure to allow you to install packages which extend or modify the look of your shell. It's fast, extensible and easy to use.



Install

curl -L github.com/oh-my-fish/oh-my-fish/raw/master/bin/install | sh
omf help

Or download and run it yourself:

curl -L github.com/oh-my-fish/oh-my-fish/raw/master/bin/install > install
chmod +x install
./install

🔰 Getting Started

Oh My Fish includes a small utility omf to fetch and install new packages and themes.

omf update

Update the framework and installed packages.

omf install [<name>|<url>]

Install one or more packages.

  • You can install packages directly by URL via omf install URL
  • When called without arguments, install missing packages from bundle.

omf list

List installed packages.

omf theme <theme>

Apply a theme. To list available themes type omf theme.

omf remove <name>

Remove a theme or package.

Packages subscribed to uninstall_<pkg> events are notified before the package is removed to allow custom cleanup of resources. See Uninstall.

omf new pkg | theme <name>

Scaffold out a new package or theme.

This creates a new directory under $OMF_CONFIG/{pkg | themes}/ with a template.

omf submit pkg/<name> [<url>]

Add a new package. To add a theme use omf submit themes/<name> <url>.

Make sure to send us a PR to update the registry.

omf query <variable name>

Use to inspect all session variables. Useful to dump path variables like $fish_function_path, $fish_complete_path, $PATH, etc.

omf destroy

Uninstall Oh My Fish. See uninstall for more information.

Advanced

Startup

This script runs each time a new session begins, autoloading packages, themes and your config path in that order.

The config path (~/.config/omf by default) is defined by $OMF_CONFIG in ~/.config/fish/config.fish. Modify this to load your own configuration, if you have any, as discussed in the FAQ.

Dotfiles

The $OMF_CONFIG directory represents the user state of Oh My Fish, and is the perfect candidate for being added to your dotfiles and/or checked out to version control. There are two important files:

  • theme - The current theme
  • bundle - List of currently installed packages/themes

About the bundle

Everytime a package/theme is installed or removed the bundle file is updated. You can also edit it manually and run omf install afterwards to satisfy the changes. Please note that while packages/themes added to the bundle gets automagically installed, a package/theme removed from bundle isn't removed from user installation.

Creating Packages

Oh My Fish uses an advanced and well defined plugin architecture to ease plugin development, including init/uninstall events and function autoloading. See the documentation for more details.

License

MIT © Oh My Fish 🤘