< Back

fishSource file

Options

abbreviations#

Custom abbreviations to be injected into the wrapped package.

Each attribute should map an abbreviation to its expansion. The values can either be:

Type
attrsOf<either<abbr, listOf<attrsOf<abbr>>>>
Example
{
  c = "git commit";
  git = [
    {
      m = "merge";
    }
    {
      rbi = {
        expansion = "rebase -i HEAD~%";
        setCursor = true;
      };
    }
  ];
  s = "git status";
}

completions#

Custom completions to be injected into the wrapped package.

Each attribute should map the name of a command to inline fish script defining how the command should be completed.

Disjoint with the completionFiles option.

Type
attrsOf<string>

completionsFiles#

Files containing custom completions to be injected into the wrapped package.

Disjoint with the completions option.

Type
listOf<pathLike>

functions#

Custom functions to be injected into the wrapped package.

Each attribute should map the name of a function to inline fish script defining its functionality.

Disjoint with the functionsFiles option.

Type
attrsOf<string>

functionsFiles#

Files containing custom functions to be injected into the wrapped package.

Disjoint with the functions option.

Type
listOf<pathLike>

interactiveShellInit#

Shell initialization code to be automatically injected into the wrapped package.

Only ran when Fish is initialized interactively.

Type
string

package#

The Fish package to be wrapped.

Type
derivation