mirror of https://github.com/jorgebucaran/fisher synced 2024-11-17 15:25:48 +00:00

Lorenzo Manacorda 8e57d3744d Explain ls-remote --format option

Add example of using `ls-remote --format` to display additional info about available plugins.

2016-11-19 17:08:44 +01:00

3.9 KiB

Raw Blame History

fisherman

A plugin manager for fish.

Translations: 日本語, 繁體中文, 简体中文, 한국어, Русский, Português, Español, Français, Català, Deutsch, فارسی.

Install

curl -Lo ~/.config/fish/functions/fisher.fish --create-dirs git.io/fisher

Usage

Install a plugin.

fisher mono

Install some plugins.

fisher z fzf edc/bass omf/thefuck

Install a gist.

fisher https://gist.github.com/username/1f40e1c6e0551b2666b2

Install a local directory.

fisher ~/my/plugin

Edit your fishfile and run fisher to commit changes.

$EDITOR ~/.config/fish/fishfile
fisher

Show everything you've installed.

fisher ls
@ plugin     # a local plugin
* mono       # current theme
  bass
  fzf
  thefuck
  z

Show everything that's available.

fisher ls-remote

Show additional information about available plugins:

fisher ls-remote --format="%name(%stars): %info [%url]\n"

Update everything.

fisher up

Update plugins.

fisher up bass z fzf

Remove plugins.

fisher rm thefuck

Remove all the plugins.

fisher ls | fisher rm

Get help.

fisher help z

FAQ

Is fisherman compatible with oh-my-fish themes and plugins?

Yes.

Where does fisherman put stuff?

The configuration and cache are saved to ~/.config/fisherman and ~/.cache/fisherman respectively.

The fishfile and plugins are saved to ~/.config/fish by default.

To customize this location:

set -U fish_path ~/my/path

What is a fishfile and how do I use it?

The fishfile lists what you've installed, and it's automatically updated as you install / remove plugins.

If you prefer, you can edit this file and run fisher to install missing plugins and dependencies.

What is a plugin?

A plugin is:

a directory with one or more .fish functions either at the root level of the project or inside a functions directory
a theme or prompt: a fish_prompt.fish and/or fish_right_prompt.fish
a snippet: one or more .fish files inside a directory named conf.d, run by fish at the start of the session

How can I list plugins as dependencies to my plugin?

Create a new fishfile at the root level of your project and write the plugin URL such as github.com/owner/repo.

Why am I receiving errors when running `fisher ls-remote`?

You can export the GITHUB_USER and GITHUB_TOKEN environment variables in your shell, to prevent GitHub's search API from rejecting anonymous requests:

set -x GITHUB_USER your_username
set -x GITHUB_TOKEN your_github_api_token_for_fisherman

3.9 KiB Raw Blame History