oh-my-fish/lib
Derek Stavis ce2fa98290
Some checks failed
Build / build (3, ubuntu-20.04) (push) Has been cancelled
Build / build (3, ubuntu-22.04) (push) Has been cancelled
Build / build (3, ubuntu-latest) (push) Has been cancelled
Build / build (4, ubuntu-22.04) (push) Has been cancelled
Build / build (brew, macos-13) (push) Has been cancelled
Build / build (brew, macos-14) (push) Has been cancelled
Build / build (brew, macos-latest) (push) Has been cancelled
Build / build (brew, ubuntu-20.04) (push) Has been cancelled
Build / build (brew, ubuntu-22.04) (push) Has been cancelled
Build / build (brew, ubuntu-latest) (push) Has been cancelled
Build / build (stock, ubuntu-20.04) (push) Has been cancelled
Build / build (stock, ubuntu-22.04) (push) Has been cancelled
Build / build (stock, ubuntu-latest) (push) Has been cancelled
chore: bumps min fish version to 3, remove use of IFS (#952)
This removes the use of IFS which has been deprecated and will be removed in future versions of Fish as per [this comment](https://github.com/oh-my-fish/oh-my-fish/issues/947#issuecomment-2483386219). I replaced the few uses of it by `read --delimiter`. This also bumps the minimum Fish version to 3.0.0.
2025-01-23 18:15:50 -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 chore: bumps min fish version to 3, remove use of IFS (#952) 2025-01-23 18:15:50 -08: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 chore: bumps min fish version to 3, remove use of IFS (#952) 2025-01-23 18:15:50 -08:00

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