github-mirror/oh-my-fish
2
0
Fork 0
mirror of https://github.com/oh-my-fish/oh-my-fish.git synced 2024-11-25 09:41:40 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
106c8e350b
oh-my-fish/lib
History
Derek Willian Stavis 7c3db938c2 docs: improve headers, use flag emojis for translations (#370)
2016-07-24 01:25:01 -03:00
..
completions %%% United States of the Fish → Wahoo + OMF %%% 2015-08-27 00:20:13 +09:00
git lib/git: fix branch name in detached head (#366) 2016-07-22 13:27:38 -03:00
autoload.fish autoload: refactor for conformance and performance (#262) 2016-06-01 01:14:30 -03:00
prompt_segments.fish %%% United States of the Fish → Wahoo + OMF %%% 2015-08-27 00:20:13 +09:00
README.md docs: improve headers, use flag emojis for translations (#370) 2016-07-24 01:25:01 -03:00
require.fish require: fix completions autoload (#343) 2016-06-07 21:27:14 -03:00

README.md

Core Library

Oh My Fish Documentation


require [--no-bundle] <name>...

require [--no-bundle] --path <path>...

Does initialization of Oh My Fish compatible packages:

  • Autoload function and completion paths
  • Source key bindings
  • Require dependencies from bundle
  • Source init.fish file

require support packages in the following directory structure:

functions/
completions/
bundle
init.fish
key_bindings.fish

When using the form require <name>..., the search path for packages is
$OMF_CONFIG and $OMF_PATH. It's also possible to require directories
using --path switch. To ignore dependency loading you can also use
--no-bundle switch

This function is the base of Oh My Fish framework, being responsible for
the major part of framework's own startup code.

autoload [-e] <path>...

Manipulate autoloading path components.

All paths ending with completions are correctly added to or erased from
$fish_complete_path.

To add paths to autoload:

autoload $mypath $mypath/completions

To erase paths from autoload:

autoload -e $mypath $mypath/completions