mirror of https://github.com/jorgebucaran/fisher synced 2024-07-02 23:11:48 +02:00

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

2.2 KiB

Raw Blame History

fisher(1) -- Fish Plugin Manager

SYNOPSIS

fisher command [options] [--version] [--help]
fisher --list
fisher --alias[=command=[alias[,...]]]
fisher --file=fishfile

DESCRIPTION

Fisherman is a plugin manager for fish(1) that lets you share and reuse code, prompts and configurations easily.

The following commands are available: install, uninstall, update, search and help. See fisher help command for information about each command.

OPTIONS

--list: List plugins in the $fisher_cache. Includes plugins installed using a custom URL.
-a --alias[=command=[alias[,...]]]: Define one or more comma-separated alias for command using $fisher_alias. If no value is given, lists all existing aliases.
-f --file=fishfile: Read fishfile and display its contents. If fishfile is null or an empty string, your user fishfile in $fisher_config/fishfile will be used instead. Use a dash - to force reading from the standard input. oh-my-fish bundle files are supported as well.
-v --version: Show version information. Fisherman's current version can be found in the VERSION file at the root of the project. The version scheme is based in Semantic Versioning and uses Git annotated tags to track releases.
-h --help: Show usage help.

CUSTOM COMMANDS

A Fisherman command is a function that you can invoke using the fisher utility. By convention, any function like fisher_<my_command> is registered as a Fisherman command. You can create plugins that add new commands this way. See fisher help commands and fisher help plugins for more information.

EXAMPLES

Install plugins.

fisher install fishtape shark

Install plugins from a fishfile or bundle:

fisher --file=path/to/shared/fishfile | fisher install

Define a few aliases:

fisher -a uninstall=rm,u,del

AUTHORS

Fisherman was created by Jorge Bucaran j@bucaran.me.

See AUTHORS file for a more complete list of contributors.

2.2 KiB Raw Blame History