mirror of https://github.com/jorgebucaran/fisher synced 2024-11-05 12:00:17 +00:00

Notable changes:

+ Now fisher list does not show plugins that are disabled,
  but available in the cache. To preview these items use
  fisher list --disabled.

+ Welcome aboard @orangecms and @xrain0610.

+ Fisherman is now available in AUR, thanks @orangecms.

+ Fix load order during installation. Now snippets can
  safely invoke functions defined in the plugin function
  directory. Thanks @orangecms. #170.

+ Fisherman **installs and updates plugins ⌁concurrently**.
  Performance may vary, but if you can see 5 to 10 times
  faster network times, it's working well.

2016-03-31 02:42:44 +09:00

2.4 KiB

Raw Blame History

fisher-install(1) -- Install plugins

SYNOPSIS

fisher install [plugins ...] [--quiet] [--help]

USAGE

fisher install url
fisher install name
fisher install path
fisher install owner/repo

DESCRIPTION

Install one or more plugins. If no arguments are given, read the standard input.

In addition, all of the following owner/repo variations are accepted:

owner/repo https://github.com/owner/repo
github/owner/repo https://github.com/owner/repo
gh/owner/repo https://github.com/owner/repo

Shortcuts to other common Git repository hosting services are also available:

bb/owner/repo https://bitbucket.org/owner/repo
gl/owner/repo https://gitlab.com/owner/repo
omf/owner/repo https://github.com/oh-my-fish/repo

If a URL is given, the repository is cloned to $fisher_cache the first time and any relevant plugin files are copied to $fisher_config functions, completions, conf.d and man directories.

If the plugin already exists in $fisher_cache, the files are only copied to $fisher_config. To update a plugin use fisher update.

If the plugin declares dependencies, these will be installed too. If any of the dependencies are already enabled or downloaded to the cache, they will not be updated to prevent version issues.

If a plugin includes either a fish_prompt.fish or fish_right_prompt.fish, both files are first removed from $fisher_config/functions and then the new ones are copied.

OPTIONS

-q, --quiet: Enable quiet mode.
-h, --help: Show usage help.

DIRECTORY TREE

The directory tree in my_plugin

my_plugin
|-- README.md
|-- my_plugin.fish
|-- functions
|   `-- my_plugin_helper.fish
|-- completions
|   `-- my_plugin.fish
|-- test
|   `-- my_plugin.fish
`-- man
    `-- man1
        `-- my_plugin.1

The directory tree in $fisher_config after running fisher install my_plugin:

$fisher_config
|-- functions
|   |-- my_plugin.fish
|   `-- my_plugin_helper.fish
|-- completions
|   `-- my_plugin.fish
|-- man
|   `-- man1
|       `-- my_plugin.1
`-- cache
    |-- my_other_plugin
    `-- my_plugin/...

SNIPPETS

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

EXAMPLES

Install plugins from multiple sources.

fisher install fishtape superman ~/plugins/my_plugin

2.4 KiB Raw Blame History