Simplify, remove hard to maintain numbers.

pull/445/head
Jorge Bucaran 9 years ago
parent fa906cbada
commit be827c7b8e
No known key found for this signature in database
GPG Key ID: E54BA3C0E646DB30

@ -4,7 +4,7 @@
[travis-badge]: https://img.shields.io/travis/fisherman/fisherman.svg [travis-badge]: https://img.shields.io/travis/fisherman/fisherman.svg
[organization]: https://github.com/fisherman [organization]: https://github.com/fisherman
[fish-shell]: https://github.com/fish-shell/fish-shell [fish]: https://fish.sh
[fisherman]: http://fisherman.sh [fisherman]: http://fisherman.sh
[online]: http://fisherman.sh/#search [online]: http://fisherman.sh/#search
@ -19,9 +19,9 @@
[![Build Status][travis-badge]][travis-link] [![Build Status][travis-badge]][travis-link]
[![Slack][slack-badge]][slack-link] [![Slack][slack-badge]][slack-link]
# [fisherman] - fish plugin manager # [fisherman]
fisherman is a concurrent plugin manager for [fish-shell]. A plugin manager for [fish].
Translations: [日本語], [简体中文], [한국어], [Русский], [Català], [Português], [Español]. Translations: [日本語], [简体中文], [한국어], [Русский], [Català], [Português], [Español].
@ -37,8 +37,6 @@ Translations: [日本語], [简体中文], [한국어], [Русский], [Catal
## Install ## Install
With curl.
```sh ```sh
curl -Lo ~/.config/fish/functions/fisher.fish --create-dirs git.io/fisherman curl -Lo ~/.config/fish/functions/fisher.fish --create-dirs git.io/fisherman
``` ```
@ -54,13 +52,7 @@ fisher simple
Install from multiple sources. Install from multiple sources.
``` ```
fisher z fzf omf/{grc,thefuck} fisher z fzf edc/bass omf/tab
```
Install from a URL.
```
fisher https://github.com/edc/bass
``` ```
Install a gist. Install a gist.
@ -72,30 +64,29 @@ fisher https://gist.github.com/username/1f40e1c6e0551b2666b2
Install a local directory. Install a local directory.
```sh ```sh
fisher ~/my_aliases fisher ~/plugin
``` ```
Edit your [fishfile](#6-what-is-a-fishfile-and-how-do-i-use-it) and run `fisher` to satisfy changes. Edit your [fishfile](#what-is-a-fishfile-and-how-do-i-use-it) and run `fisher` to satisfy changes.
```sh ```sh
$EDITOR fishfile # add plugins $EDITOR ~/.config/fish/fishfile
fisher fisher
``` ```
See what's installed. List what you've installed.
```ApacheConf ```ApacheConf
fisher ls fisher ls
@ my_aliases # this is a local directory @ plugin # a local directory
* simple # this is the current prompt * simple # the current prompt
bass bass
fzf fzf
grc tab
thefuck
z z
``` ```
See everything available. List everything that's available.
``` ```
fisher ls-remote fisher ls-remote
@ -110,7 +101,7 @@ fisher up
Update some plugins. Update some plugins.
``` ```
fisher up bass z fzf thefuck fisher up bass z fzf
``` ```
Remove plugins. Remove plugins.
@ -131,13 +122,19 @@ Get help.
fisher help z fisher help z
``` ```
Uninstall fisherman.
```
fisher self-uninstall
```
## FAQ ## FAQ
### 1. What is the required fish version? ### What is the required fish version?
\>=2.2.0. \>=2.2.0.
For [snippet](#8-what-is-a-plugin) support, upgrade to 2.3.0 or append the following code to your *~/.config/fish/config.fish*. For [snippet](#what-is-a-plugin) support, upgrade to >=2.3.0 or append the following code to your *~/.config/fish/config.fish*.
```fish ```fish
for file in ~/.config/fish/conf.d/*.fish for file in ~/.config/fish/conf.d/*.fish
@ -145,66 +142,34 @@ for file in ~/.config/fish/conf.d/*.fish
end end
``` ```
### 2. How do I use fish as my default shell? ### Is fisherman compatible with oh-my-fish themes and plugins?
Add fish to the list of login shells in */etc/shells* and make it the default.
```sh
echo "/usr/local/bin/fish" | sudo tee -a /etc/shells
chsh -s /usr/local/bin/fish
```
### 3. How do I uninstall fisherman?
```fish
fisher self-uninstall
```
### 4. Is fisherman compatible with oh my fish themes and plugins?
Yes. Yes.
### 5. Where does fisherman put stuff? ### Where does fisherman put stuff?
The cache and configuration go in *~/.cache/fisherman* and *~/.config/fisherman* respectively. The cache and configuration go in *~/.cache/fisherman* and *~/.config/fisherman* respectively.
The fishfile is saved to *~/.config/fish/fishfile*. The fishfile is saved to *~/.config/fish/fishfile*.
### 6. What is a fishfile and how do I use it? ### What is a fishfile and how do I use it?
The fishfile *~/.config/fish/fishfile* lists all the installed plugins. The fishfile *~/.config/fish/fishfile* lists all the installed plugins.
You can let fisherman take care of this file for you automatically, or write in the plugins you want and run `fisher` to satisfy the changes. You can let fisherman take care of this file for you automatically, or write in the plugins you want and run `fisher` to satisfy the changes.
``` This mechanism only installs plugins and missing dependencies. To remove plugins, use `fisher rm`.
fisherman/simple
fisherman/z
omf/thefuck
omf/grc
```
This mechanism only installs plugins and missing dependencies. To remove a plugin, use `fisher rm` instead.
### 7. Where can I find the list of fish plugins?
Browse the [organization] or use the [online] search to discover content.
### 8. What is a plugin? ### What is a plugin?
A plugin is: A plugin is:
1. a directory or git repo with a function *.fish* file either at the root level of the project or inside a *functions* directory 1. a directory or git repo with one or more *.fish* functions either at the root level of the project or inside a *functions* directory
2. a theme or prompt, i.e, a *fish_prompt.fish*, *fish_right_prompt.fish* or both files 2. a theme or prompt, i.e, a *fish_prompt.fish*, *fish_right_prompt.fish* or both files
3. a snippet, i.e, one or more *.fish* files inside a directory named *conf.d* that are evaluated by fish at the start of the shell 3. a snippet, i.e, one or more *.fish* files inside a directory named *conf.d*, evaluated by fish at the start of the session
### 9. How can I list plugins as dependencies to my plugin? ### How can I list plugins as dependencies to my plugin?
Create a new *fishfile* file at the root level of your project and write in the plugin dependencies. Create a new *fishfile* file at the root level of your project and write in the plugins you'd like to depend on.
```fish
owner/repo
https://github.com/owner/repo
https://gist.github.com/owner/c256586044fea832e62f02bc6f6daf32
```

Loading…
Cancel
Save