https://github.com/paysonwallach/fish-you-should-use
A fish plugin that reminds you to use your aliases.
https://github.com/paysonwallach/fish-you-should-use
fish fish-plugin fish-shell fisher
Last synced: 5 months ago
JSON representation
A fish plugin that reminds you to use your aliases.
- Host: GitHub
- URL: https://github.com/paysonwallach/fish-you-should-use
- Owner: paysonwallach
- License: gpl-3.0
- Created: 2020-04-21T05:02:06.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-29T05:56:23.000Z (about 2 years ago)
- Last Synced: 2024-04-23T22:14:19.990Z (about 2 years ago)
- Topics: fish, fish-plugin, fish-shell, fisher
- Language: Shell
- Homepage:
- Size: 1.42 MB
- Stars: 37
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
You Should Use
A fish plugin that reminds you to use your aliases.
[You Should Use](git+https://github.com/paysonwallach/fish-you-should-use.git) is a rewrite of [You Should Use](https://github.com/MichaelAquilina/zsh-you-should-use) for [fish](https://fishshell.com/).
## Installation
Using [`fisher`](https://github.com/jorgebucaran/fisher):
```shell
fisher install paysonwallach/fish-you-should-use
```
## Usage
Simply install and get back to whatever you were doing before! [You Should Use](git+https://github.com/paysonwallach/fish-you-should-use.git) will let you know when you've typed out a command that exists as an alias.
## Configuration
By default, [You Should Use](git+https://github.com/paysonwallach/fish-you-should-use.git) will display its reminder message after a command has executed. However, you can choose to display the mesasge before execution by setting `YSU__MESSAGE_POSITION` like so:
```fish
set YSU_MESSAGE_POSITION "before"
```
## Contributing
Feel free to take a look at [TODO.md](https://github.com/paysonwallach/fish-you-should-use/blob/master/TODO.md), otherwise pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.
## License
[You Should Use](git+https://github.com/paysonwallach/fish-you-should-use.git) is licensed under the [GNU General Public License v3.0](https://github.com/paysonwallach/fish-you-should-use/blob/master/LICENSE).