English • 简体中文

Install

curl -sL get.fisherman.sh | fish

Usage

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

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 a prompt
• * The plugin is installed
• @ 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

Bundle

When you install a plugin, fisherman updates the bundle file to track what plugins are currently active.

• Customize the location of the bundle.

set -g fisher_file ~/.dotfiles/bundle

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
├── bundle
├── 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/fisherman/z
Pure-fish z directory jumping
z search cd jump
jethrokuan

If you have a plugin you would like to submit to the index, send us a PR here index repository.

git clone https://github.com/fisherman/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 bundle, key_bindings.fish, cache, functions, completions and conf.d directories. XDG_CONFIG_HOME/fisherman by default.

• $fisher_file: The location of the bundle file.

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

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