github-mirror/oh-my-fish
2
0
Fork 0
mirror of https://github.com/oh-my-fish/oh-my-fish.git synced 2024-12-03 23:37:11 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
master
oh-my-fish/lib
History
jjangga0214 446a94a766
docs: rm unnecessary img tag from readme (#859)
2022-03-08 14:27:48 -08:00
..
completions %%% United States of the Fish → Wahoo + OMF %%% 2015-08-27 00:20:13 +09:00
git Fix error when inside a bare git repository 2020-12-01 01:47:35 -08:00
autoload.fish Add missing quotation marks in autoload (#711) 2019-07-22 22:21:53 -07:00
prompt_segments.fish %%% United States of the Fish → Wahoo + OMF %%% 2015-08-27 00:20:13 +09:00
README.md docs: rm unnecessary img tag from readme (#859) 2022-03-08 14:27:48 -08:00
require.fish Put conf_file loop outside of init_file loop (#666) 2019-01-10 19:57:14 -02: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