https://github.com/samthesomebody/qcka
Quick alias is a tool for adding and managing bash aliases on the fly.
https://github.com/samthesomebody/qcka
aliases bash cli go workflow
Last synced: 2 months ago
JSON representation
Quick alias is a tool for adding and managing bash aliases on the fly.
- Host: GitHub
- URL: https://github.com/samthesomebody/qcka
- Owner: SamTheSomebody
- License: gpl-3.0
- Created: 2025-05-06T00:26:07.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-08T09:48:38.000Z (about 1 year ago)
- Last Synced: 2025-05-09T01:45:17.690Z (about 1 year ago)
- Topics: aliases, bash, cli, go, workflow
- Language: Go
- Homepage:
- Size: 42 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Unlicense License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
qcka
Quick alias is a bash tool to add and manage aliases without having to edit your .bashrc or .bash_aliases.
View Demo (TODO)
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
Quick alias allows you to add, manage, remove and view your bash aliases on the fly. It has simple grouping to help keep things organized.
Here's why:
* Don't stop what you're doing. You're using aliases to speed up your workflow, so speed up managing them!
* A 'here' function to bookmark your current directory.
* Alias validation and override dectection for inbuilts, commands, funcitons and other aliases.
### Built With
## Getting Started
I'm still working on a release of qcka, for now it can only be built from source.
### Prerequisites
* Go: https://go.dev/doc/install
### Installation
To build from source:
1) Clone this repository.
2) Change to it's directory.
3) Run the following command:
```
go build && export PATH=$PATH:$(go list -f '{{.Target}}') && go install
```
## Usage
Run quick alias with the command: ```qcka```
Quick alias features a built-in manual, alongside 'did you mean' suggestions.
For more information run: ```qcka --help```
*TODO: [generate markdown documentation using cobra](https://github.com/spf13/cobra/blob/main/site/content/docgen/md.md).*
## Roadmap
- [x] Alias validation
- [ ] Documentation
- [ ] Test suite
- [ ] Build pipeline
- [ ] Package & release
See the [open issues](https://github.com/SamTheSomebody/qcka/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
### Top contributors:
## License
Distributed under the GNU GPLv3 License.
See `LICENSE` for more information.
## Contact
@SamTheSomebody aka @GameDevSam
Sam Muller - gamedevsam@pm.me
## Acknowledgments
* [Cobra](https://github.com/spf13/cobra) for making cli tools so easy.
* othneildrew for the [best README template](https://github.com/othneildrew/Best-README-Template).
* [Boot.dev](https://www.boot.dev) for giving me the skills to make this.
[contributors-shield]: https://img.shields.io/github/contributors/samthesomebody/qcka.svg?style=for-the-badge
[contributors-url]: https://github.com/SamTheSomebody/qcka/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/samthesomebody/qcka.svg?style=for-the-badge
[forks-url]: https://github.com/SamTheSomebody/qcka/network/members
[stars-shield]: https://img.shields.io/github/stars/samthesomebody/qcka.svg?style=for-the-badge
[stars-url]: https://github.com/SamTheSomebody/qcka/stargazers
[issues-shield]: https://img.shields.io/github/issues/samthesomebody/qcka.svg?style=for-the-badge
[issues-url]: https://github.com/SamTheSomebody/qcka/issues
[license-shield]: https://img.shields.io/github/license/samthesomebody/qcka.svg?style=for-the-badge
[license-url]: https://github.com/SamTheSomebody/qcka/blob/master/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/gamedevsam/