fisher/man/man7/fisher-commands.md
Jorge Bucaran ee0338d5b0
Ahoy! Fisherman gets a super patch v0.3.1
This patch contains several amends for 0.3.0 and
other minor documentation corrections.  Major
documentation revision and rewrite.

fisher help shows fisher(1) by default now.

Fix a critical bug that was causing fisher uninstall
--force to remove not the symbolic link, but the
actual files. Closes #24

Rename orphan tag to custom for plugins installed
using a custom URL.

warning Remove fisher --link flag and create symbolic
links by default for local paths. The user does not
have to worry about symbolic links or whether the
copy is as symbolic link or not anymore. If the user
tries to install a local path, then the best thing
to do is to create a symbolic link. This also
eliminates the need to call update.

warning Remove fisher --cache and fisher --validate.
Now, that these options are separated into their own
function and they are intentionally private, there
is no need for them.
2016-01-10 16:13:46 +09:00

1.2 KiB

fisher-commands(7) -- Creating Fisherman Commands

SYNOPSIS

This document describes how to add new commands to Fisherman. A Fisherman command is a function that you can invoke like fisher command [options].

DESCRIPTION

To add a command, create a function fisher_<my_command>:

function fisher_hello -d "Friendly command"
    echo hello
end

Make sure it works: fisher hello.

To make this function available to the current and future fish sessions, add it to $XDG_CONFIG_HOME/fish/functions:

funcsave fisher_hello

You may also choose to save this function to $fisher_config/functions.

EXAMPLES

The following example implements a command to retrieve plugin information and format the output into columns.

function fisher_info -d "Display information about plugins"
    switch "$argv"
        case -h --help
            printf "usage: fisher info name | URL [...]\n\n"
            printf "    -h --help  Show usage help\n"
            return
    end
    for item in $argv
        fisher search $item --name --info
    end | sed -E 's/;/: /' | column
end

SEE ALSO

fisher(1)
fisher(7)
funcsave(1)
fisher help plugins