https://github.com/KamilKleina/alias-finder.nu
A package that provides a tip in Nushell, suggesting the use of an alias for commands that haven't been used with it.
https://github.com/KamilKleina/alias-finder.nu
Last synced: about 1 month ago
JSON representation
A package that provides a tip in Nushell, suggesting the use of an alias for commands that haven't been used with it.
- Host: GitHub
- URL: https://github.com/KamilKleina/alias-finder.nu
- Owner: KamilKleina
- License: mit
- Created: 2025-03-10T11:11:45.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-03-10T11:15:33.000Z (about 1 month ago)
- Last Synced: 2025-03-10T12:26:06.053Z (about 1 month ago)
- Language: Nushell
- Size: 1000 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-nu - alias-finder.nu
README
# Table of Contents
- [Description](#description)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [Changelog](#changelog)
- [License](#license)
## Description
A simple Nushell plugin that shows an alias when you use a command that has
an alias defined. Useful for remembering previously set aliases.
Written as a pure Nushell script for speed. Extremely simple (directly looks
up the command in `aliases`)
```nu
> ls -a
"Alias Tip: la"
│ # │ name │
├───┼──────────────┤
│ 0 │ CHANGELOG.md │
│ 1 │ LICENCE │
│ 2 │ README.md │
│ 3 │ alias-finder │
│ 4 │ nupm.nuon │
```
## Installation
Clone the repository and source the module in your `config.nu`:
```nu
overlay use /path/to/alias-finder.nu
```
## Usage
Once sourced, you'll see a tip about
using an alias for the command if you haven’t used it.
## Contributing
Issues and pull requests are welcome!
Feel free to contribute improvements or new features.
## Changelog
All changelogs can be found in the [CHANGELOG.md](./CHANGELOG.md) file.
## License
This project is licensed under the MIT License.
## Inspiration
This plugin is based on
[zsh-alias-finder](https://github.com/akash329d/zsh-alias-finder), originally
created for Zsh. It has been adapted for Nushell to provide the same
functionality
## TODO
- [ ] Add option to ignore certain commands
- [ ] Add option to show the tip in different format