oh-my-fish/lib/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