fisher/README.md

Fisherman is a blazing fast, modern plugin manager for fish.

curl -sL get.fisherman.sh | fish

_{Install instructions for fish can be found here.}

Install

Download Fisherman using Git and setup your system automatically. See other install options.

curl -sL get.fisherman.sh | fish

CLI

The Fisherman CLI consists of: install, update, uninstall, list, search and help and the following aliases: i for install, u for update, l for list, s for search and h for help.

Examples

• Install plugins.

fisher i fishtape shark get bobthefish

• Install Oh My Fish! plugins.

fisher i omf/plugin-{percol,jump,fasd}

• Install a plugin from a local directory.

fisher i ./path/to/plugin

• Install a plugin from various URLs.

fisher i https://github.com/some/plugin another/plugin bb:one/more

• Install a plugin from a Gist.

fisher i gist.github.com/owner/1f40e1c6e0551b2666b2

• Update everything.

fisher u

• Update plugins.

fisher u shark get

• Uninstall plugins.

fisher uninstall fishtape debug

• Get help.

fisher h

List and search

The list command displays all the plugins you have installed. The search command queries the index to show what's available to install.

List installed plugins.

fisher list
  debug
* fishtape
* spin
> superman
@ wipe

Search the index.

fisher search
  ...
* debug        Conditional debug logger
  errno        POSIX error code/string translator
* fishtape     TAP producing test runner
  flash        Flash-inspired, thunder prompt
  fzf          Efficient keybindings for fzf
  get          Press any key to continue
  ...
> superman     Powerline prompt based on Superman
  ...

Query the index using regular expressions.

fisher search --name~/git-is/
git-is-dirty       Test if there are changes not staged for commit
git-is-empty       Test if a repository is empty
git-is-repo        Test if the current directory is a Git repo
git-is-staged      Test if there are changes staged for commit
git-is-stashed     Test if there are changes in the stash
git-is-touched     Test if there are changes in the working tree

Search using tags.

fisher search --tag={git,test}
  ...
  * fishtape         TAP producing test runner
  git-branch-name    Get the name of the current Git branch
  git-is-dirty       Test if there are changes not staged for commit
  git-is-empty       Test if a repository is empty
  git-is-repo        Test if the current directory is a Git repo
  git-is-staged      Test if there are changes staged for commit
  git-is-stashed     Test if there are changes in the stash
  git-is-touched     Test if there are changes in the working tree
  ...

The legend consists of:

• * The plugin is enabled
• > The plugin is a prompt
• @ The plugin is a symbolic link

Plumbing

Fisherman commands are pipe aware. Plumb one with another to create complex functionality.

Update plugins installed as symbolic links.

fisher list --link | fisher update -

Enable all the plugins currently disabled.

fisher list --disabled | fisher install

Uninstall all the plugins and remove them from the cache.

fisher list | fisher uninstall --force

Dotfiles

When you install a plugin, Fisherman updates the fishfile to track what plugins are currently enabled.

• Customize the location of the fishfile.

set -g fisher_file ~/.dotfiles/fishfile

Flat Tree

Fisherman merges the directory trees of all the plugins it installs into a single flat tree. Since the flat tree is loaded only once at the start of the shell, Fisherman performs equally well, regardless of the number of plugins installed.

The following illustrates an example Fisherman configuration path with a single plugin and prompt.

$fisher_config
├── cache
├── completions
│   └── my_plugin.fish
├── conf.d
│   └── my_plugin.fish
├── fishfile
├── functions
│   ├── fish_prompt.fish
│   ├── fish_right_prompt.fish
│   └── my_plugin.fish
└── man
    └── man1
        └── my_plugin.1

Index

The index is a plain text database that lists Fisherman official plugins.

The index lists records, each consisting the fields: name, url, info, one or more tags and author.

z
https://github.com/fishery/fish-z
Pure-fish z directory jumping
z search cd jump
jethrokuan

If you have a plugin you would like to submit to the index, use the submit plugin.

fisher install submit
fisher submit my_plugin description tags url

Or, submit the plugin manually by creating a pull request in the index repository.

git clone https://github.com/fisherman/fisher-index
cd index
echo "$name\n$url\n$info\n$tags\n$author\n\n" >> index
git push origin master

Variables

• $fisher_home: The home directory. If you installed Fisherman using the recommended method, the location ought to be XDG_DATA_HOME/fisherman.

• $fisher_config: The configuration directory. This is default location of your fishfile, key_bindings.fish, cache, functions, completions and conf.d directories. XDG_CONFIG_HOME/fisherman by default.

• $fisher_file: See fishfile above.

• $fisher_cache: The cache directory. Plugins are downloaded to this location.

• $fisher_alias command=alias ...: Use this variable to create aliases of Fisherman commands.

Plugins

Plugins can be utilities, prompts, commands or snippets. To create a plugin from a template, install the new command.

fisher install new
fisher new plugin < meta.yml

See the documentation for new for details.

Utilities

Utilities are plugins that define one or more functions.

Below is a plugin based in ngerakines/commitment random commit message generator.

mkdir wtc
cd wtc

function wtc -d "Generate a random commit message"
    switch "$argv"
        case -h --help
            printf "Usage: wtc [--help]\n\n"
            printf "  -h --help  Show usage help\n"
            return
    end
    curl -s whatthecommit.com/index.txt
end
functions wtc > wtc.fish

fisher install .

wtc
(\ /)
(O.o)
(> <) Bunny approves these changes.

Submit

To submit wtc to the official index.

fisher submit wtc "Random commit message generator" "commit random fun" https://github.com/owner/wtc

This will create a PR in the Fisherman index repository. Once the PR is approved, Fisherman users will be able to install wtc if they have the latest index.

fisher install wtc

Dependencies

A plugin can list dependencies to other plugins using a fishfile.

Create a fishfile in the root of your project and add the name or URL of your dependencies.

my_plugin
https://github.com/owner/another_plugin

Prompts

Prompts, or themes, are plugins that modify the appearance of the shell prompt and colors.

Create a fish_prompt function.

function fish_prompt
    printf "%s (%s) >> " (prompt_pwd) Fisherman
end

~ (Fisherman) >> type here

To add a right prompt, create a fish_right_prompt function.

function fish_right_prompt
    printf "%s" (date +%H:%M:%S)
end

Save the functions to a directory and install the prompt as a plugin.

mkdir my_prompt
cd my_prompt

functions fish_prompt > fish_prompt.fish
functions fish_right_prompt > fish_right_prompt.fish

fisher install .

Customize the colors fish uses for syntax highlighting.

function set_color_custom
    set -U fish_color_normal    normal
    set -U fish_color_command   yellow
    set -U fish_color_param     white
end

functions set_color_custom > set_color_custom.fish

fisher update .

Commands

Commands are plugins that extend the Fisherman CLI adding new fisher <commands>.

Create a function fisher_<command>

function fisher_time -d "Say hello"
    printf "It's %s\n" (date +%H:%M)
end

Test it works

fisher time
It's 6:30

Make it a plugin

fisher install fisher_time

Snippets

Snippets are plugins that run code at the start of the shell. Snippets must be placed inside a sub directory named conf.d.

The following example implements a fish_postexec hook to display the duration of the last command in milliseconds.

mkdir -p runtime/conf.d
cd runtime
$EDITOR conf.d/fish_postexec.fish

function fish_postexec --on-event fish_postexec
    printf "%sms\n" $CMD_DURATION > /dev/stderr
end

fisher install ./postexec