Installation

Procedure

The installation involves simply moving the directories

• functions (→ $fish_function_path)
• conf.d

to the appropriate paths in the host system, depending on the installation type Each file in functions/ must be renamed such that each sub-directory's name is prefixed to it such that the file name is parentDir_childDir_file

Tip

See the function's name in the respective file to obtain the file-name of it (.fish suffixed)

Scope

User

Automatic: Package Manager

Auto-updates via the package manager
Fisher: fisher install Drazape/fish-helpText

Manual

Move the directories into your Fish configuration in the home directory (~/.config/fish/):

System

Automatic

Script (local)

This locally installs the program and updates each time it is ran

curl -fsSL 'https://raw.githubusercontent.com/Drazape/fish-helpText/main/install.fish' | run0 fish -NP

Package Manager

As of now, there is no distribution package manager supported.

NixOS

A flake with convenient configuration options is planned.

Workaround

For now, the installation can be worked-around (with automatic updates). This way is not supported and may stop working after an update.

• flake.nix:

{
	inputs = {
		fish-helpText = {
				type="github"; owner="Drazape"; repo="fish-helpText";
				flake = false;
		};
		…
	};
	outputs = inputs@{ self, nixpkgs, …, ... }: {
		nixosConfigurations."yourHost" = nixpkgs.lib.nixosSystem {
			specialArgs = { inherit inputs; };
			…
		};
		…
	};
}

• Module with the Fish configuration:

{ inputs, … }: {
	…
	programs.fish = {
		shellInit = ( # Fish Help Text (workaround)
			builtins.concatStringsSep "\n" (
				builtins.map builtins.readFile 
					(builtins.concatMap
						(componentType: (builtins.filter
									(baseName: ((builtins.match ".*\.fish$" baseName) == []))
									(lib.filesystem.listFilesRecursive (inputs.fish-helpText + ("/"+componentType)))))
						[ "functions" "completions" ]))
		) + ''
			…
		'';
		…
	};
};

Manual

The files must be moved to the vendor (vendor_*.d) system-wide path

• Package Manager: Normal system path managed by the package manager
• Local: Local directory for non-packaged programs