Skip to content

Installation

Different installation methods that are officially recognised and curated for different scenarios and needs

Dependency

  • format: Intuitively generate ANSI sequences

Procedure

The installation involves moving Fish files from the directories

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, resulting in a file name fo the format: parentDir_childDir_file

Function Name

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

Scope

The installation type determines the availability of the program to users

User

Under this scope, this program is only available to the user the installation is performed for.

Automatic: Package Manager

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

Manual

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

System

Install fish-helpText system-wide; that is, for all users.

Automatic

Following are ways to install the program without any user intervention

Script (local)

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

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

Package Manager

Use a package manager previously installed in your system to manage the installation of the package.

NixOS

Manual Dependency

You'll need to manually install the cyclic dependency.

flake.nix
{
    inputs = {
        …
        fish-helpText = { type="github"; owner="Drazape"; repo="fish-helpText"; };
        …
    };
    outputs = inputs@{ self, nixpkgs, …, ... }: {
        nixosConfigurations."yourHost" = nixpkgs.lib.nixosSystem {
            specialArgs = { inherit inputs; };
            …
        };
        …
    };
}
Module with the Fish configuration
{ inputs, pkgs, …, ... }: {
    …
    environment.systemPackages = [
        …
        inputs.fish-helpText.packages."${pkgs.stdenv.hostPlatform.system}".default
        …
    ]
    …
};

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