mirror of https://github.com/jorgebucaran/fisher synced 2024-11-09 07:10:27 +00:00

Jorge Bucaran 2cbbb00dcb Fisherman 1.0 RC

* Deprecate fisher --list in favor of a new command fisher list.
  The behavior is roughly the same. See fisher help list for
  usage. tl;dr: Use list to query the local system / cache and
  search to query the index.

* Teach fisher_plugin_walk about fish_postexec,
  fish_command_not_found and fish_preexec event emitters and
  erase them during uninstall if they were defined in a snippet.

* Fisherman now recognizes the following aliases by default:
  i for install, u for update, l for list, s for search and h
  for help.

* Large documentation rewrite. Better, simpler, more concise
  and more consistent.

* Fisherman now detects if users have modified their fish
  prompt using fish_config and if so, uninstalls $fisher_prompt.

2016-02-29 23:13:29 +09:00

2.5 KiB

Raw Blame History

fisher-install(1) -- Install plugins

SYNOPSIS

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

USAGE

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

DESCRIPTION

Install one or more plugins, by name, URL, path or function name. 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

-f, --force: Reinstall given plugin/s.
-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 simnalamburt/shellder ~/plugins/my_plugin

2.5 KiB Raw Blame History