Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abroudoux/al
🎭 Create local aliases, like package.json but everywhere
https://github.com/abroudoux/al
aliases aliases-setup go go-script go-scripts script scripts
Last synced: about 1 month ago
JSON representation
🎭 Create local aliases, like package.json but everywhere
- Host: GitHub
- URL: https://github.com/abroudoux/al
- Owner: abroudoux
- License: mit
- Created: 2024-12-11T10:25:20.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-12T11:30:37.000Z (about 2 months ago)
- Last Synced: 2024-12-12T12:31:30.886Z (about 2 months ago)
- Topics: aliases, aliases-setup, go, go-script, go-scripts, script, scripts
- Language: Go
- Homepage:
- Size: 9.77 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# al
🎭 Create local aliases, like package.json but everywhere
Version : 0.0.2
## 🚀 Installation
### Requirements
### Via Homebrew
Wip 🚧
### Manual
You can paste the binary in your `bin` directory (e.g., on mac it's `/usr/bin/local`). \
Don't forget to grant execution permissions to the binary.
```bash
chmox +x al
```
## 💻 Usage
`al` needs a `al.json` file where you define your custom aliases, generally at the root of your project. Since the config file exists, you can use `al` followed by your local alias.
```bash
# al.json
{
"test": "echo "This is a test""
}
```
```bash
# you can now use al to run your command
al test
```
You can use `--init` / `-i` to create a new config file.
```bash
al --init
```
## 🧑🤝🧑 Contributing
To contribute, fork the repository and open a pull request detailling your changes.
Create a branch with a [conventionnal name](https://tilburgsciencehub.com/building-blocks/collaborate-and-share-your-work/use-github/naming-git-branches/).
- fix: `bugfix/the-bug-fixed`
- features: `feature/the-amazing-feature`
- test: `test/the-famous-test`
- hotfix `hotfix/oh-my-god-bro`
- wip `wip/the-work-name-in-progress`
## 📌 Roadmap
- [ ] Create a new option to add a new alias from command
- [ ] Improve UI
- [ ] Improve user feedback when using an alias
- [ ] Installation via Homebrew
- [ ] Installation via apt
## 📑 License
This project is under MIT license. For more information, please see the file [LICENSE](./LICENSE).