mirror of
https://github.com/jorgebucaran/fisher
synced 2024-06-28 23:01:50 +02:00
52 lines
2.1 KiB
Markdown
52 lines
2.1 KiB
Markdown
<p align="center">
|
|
<a href="http://fisherman.sh">
|
|
<img alt="Fisherman" width=620px src="https://cloud.githubusercontent.com/assets/8317250/10865127/daa0e138-8044-11e5-91f9-f72228974552.png">
|
|
</a>
|
|
</p>
|
|
|
|
[![Build Status][travis-badge]][travis-link]
|
|
![Fisherman Version][fisherman-version]
|
|
[![Wharf][wharf-badge]][wharf-link]
|
|
|
|
## About
|
|
|
|
Fisherman is a plugin manager and CLI toolkit for [Fish][fish] to help you build powerful utilities and share your code easily.
|
|
|
|
Fisherman uses a [flat tree][flat-tree] structure that adds no cruft to your shell, making it as fast as no Fisherman. The cache mechanism lets you query the index offline and enable or disable plugins as you wish.
|
|
|
|
Other features include dependency management, great plugin search capabilities and full compatibility with **Tacklebox**, **Wahoo** and **Oh My Fish** themes and packages.
|
|
|
|
## Install
|
|
|
|
```fish
|
|
git clone https://github.com/fisherman/fisherman
|
|
cd fisherman
|
|
make
|
|
```
|
|
|
|
|
|
## Documentation
|
|
|
|
Start in the [**Wiki**][docs] for links to the documentation and other guides or jump to the [Quickstart Guide][quickstart] for a simple introduction to Fisherman. For support and feedback join the Slack [room][wharf-link] or browse the [issues][issues].
|
|
|
|
|
|
:anchor:
|
|
|
|
|
|
<!-- Links -->
|
|
|
|
[faq]: https://github.com/fisherman/fisherman/wiki/FAQ
|
|
[fish]: https://github.com/fish-shell/fish-shell
|
|
[docs]: https://github.com/fisherman/fisherman/wiki
|
|
[intro]: man/man7/fisher-tour.md
|
|
[issues]: http://github.com/fisherman/fisherman/issues
|
|
[quickstart]: https://github.com/fisherman/fisherman/wiki/Quickstart-Guide
|
|
[flat-tree]: https://github.com/fisherman/fisherman/blob/master/man/man7/fisher.md#flat-tree
|
|
[wharf-link]: https://fisherman-wharf.herokuapp.com/
|
|
[fisher-tour]: man/man7/fisher-tour.md
|
|
[wharf-badge]: https://img.shields.io/badge/wharf-join%20the%20chat-00cc99.svg?style=flat-square
|
|
[screencasts]: https://github.com/fisherman/fisherman/wiki/Screencasts
|
|
[travis-link]: https://travis-ci.org/fisherman/fisherman
|
|
[travis-badge]: https://img.shields.io/travis/fisherman/fisherman.svg?style=flat-square
|
|
[fisherman-version]: https://img.shields.io/badge/fisherman-v0.4.0-00B9FF.svg?style=flat-square
|