Installation¶

Dependencies¶

• fish-helpText (help-text)

Procedure¶

The installation involves moving Fish files from the directories

• functions (→ $fish_function_path)
• conf.d

to the appropriate paths in the host system, depending on the installation type.

Scope¶

User¶

Automatic: Package Manager¶

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

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 run

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

Package Manager¶

As of now, no distribution package manager is supported.

NixOS¶

A flake with convenient configuration options is planned.

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

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

{ inputs, … }: {
    …
    programs.fish = {
        shellInit = ( # Fish subcommand abbreviation (workaround)
            builtins.concatStringsSep "\n" ( # (4)!
                builtins.map builtins.readFile 
                    (builtins.concatMap
                        (componentType: (builtins.filter
                                    (baseName: ((builtins.match ".*\.fish$" baseName) == [])) # (3)!
                                    (lib.filesystem.listFilesRecursive (inputs.fish-format + ("/"+componentType))))) # (2)!
                        [ "conf.d" "functions" "completions" ])) # (1)!
        ) + ''
            …
        '';
        …
};

1. The directories to source
2. List of files the specified directories
3. Filter to only Fish files
4. Concatenate each file by separating them with a new line

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