https://github.com/halostatue/fish-plugin-template
A template for making new fisher-compatible fish plugins
https://github.com/halostatue/fish-plugin-template
Last synced: 17 days ago
JSON representation
A template for making new fisher-compatible fish plugins
- Host: GitHub
- URL: https://github.com/halostatue/fish-plugin-template
- Owner: halostatue
- License: mit
- Created: 2022-06-21T21:23:40.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-14T16:24:34.000Z (2 months ago)
- Last Synced: 2025-06-09T21:59:39.481Z (18 days ago)
- Language: Just
- Size: 38.1 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# halostatue/fish-plugin-template
> [!INFORMATION]
>
> Run `just init OWNER REPO *NAME` to make this your own. It will make changes
> that prepare your plug-in repository. This does _not_ commit the changes or
> make all changes for you.
> This repository is a template for creating [fisher][fisher]-compatible plugins
> for the Fish shell.
>
> From [creating a plugin][creating a plugin]:
>
>> A plugin can be any number of files in a `functions`, `conf.d`, and
>> `completions` directory. Most plugins consist of a single function, or
>> configuration [snippet][snippet]. This is what a typical plugin looks like.
>>
>> ```
>> flipper
>> ├── completions
>> │ └── flipper.fish
>> ├── conf.d
>> │ └── flipper.fish
>> └── functions
>> └── flipper.fish
>> ```
>
> When using this repository, remember to remove the `.keep` files, as their
> presence will cause installation failures.
[![Version][version]](https://github.com/OWNER/REPONAME/releases)
A short description of this module for [fish shell][fish shell].
## Installation
Install with [Fisher][fisher]:
```fish
fisher install OWNER/REPONAME@v1
```
### System Requirements
- [fish][fish] 3.0+
## Functions
> A description of the functions added by this plugin.
### flipper
> A description of the function `flipper`.
```fish
$ flipper example
example output
```
## Licence
> The licence for the plug-in. I habitually choose MIT for my Fish plugins.
[MIT](./LICENCE.md)
## Change Log
[CHANGELOG](./CHANGELOG.md)
## Contributing
- [Contributing](./CONTRIBUTING.md)
- [Contributors](./CONTRIBUTORS.md)
- [Code of Conduct](./CODE_OF_CONDUCT.md)
[fish shell]: https://fishshell.com 'friendly interactive shell'
[fisher]: https://github.com/jorgebucaran/fisher
[fish]: https://github.com/fish-shell/fish-shell
[version]: https://img.shields.io/github/tag/OWNER/REPONAME.svg?label=Version
[creating a plugin]: https://github.com/jorgebucaran/fisher#creating-a-plugin
[snippet]: https://fishshell.com/docs/current/index.html#configuration-files
[events]: https://fishshell.com/docs/current/cmds/emit.html