https://github.com/love1ace/byul-alias
Simple git config manager
https://github.com/love1ace/byul-alias
aliases byul byulhook config git git-alias
Last synced: 9 months ago
JSON representation
Simple git config manager
- Host: GitHub
- URL: https://github.com/love1ace/byul-alias
- Owner: love1ace
- License: mit
- Created: 2024-08-27T08:53:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-27T10:24:04.000Z (over 1 year ago)
- Last Synced: 2025-07-04T14:42:35.949Z (9 months ago)
- Topics: aliases, byul, byulhook, config, git, git-alias
- Language: JavaScript
- Homepage:
- Size: 11.7 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# byul-alias
**byul-alias** is a simple git alias manager.
## Installation
You can install **byul-alias** using your preferred package manager:
### npm
```bash
npm install byul-alias
```
### Yarn
```bash
yarn add byul-alias
```
### pnpm
```bash
pnpm add byul-alias
```
### Bun
```bash
bun add byul-alias
```
## Setup error
If the `byul-alias.yml` file hasn’t been created, run:
```bash
node node_modules/byul-alias/dist/setup.mjs
```
Or, you can manually create the `byul-alias.yml` file and add this code:
```yaml
# Common Git Alias Shortcuts
# --------------------------
# You can customize these aliases however you like.
# Below are some of the most commonly used Git aliases:
# co: checkout -> Switch branches or restore working tree files
# br: branch -> List, create, or delete branches
# ci: commit -> Record changes to the repository
# st: status -> Show the working tree status
# lg: log --oneline --graph --decorate -> Show a graphical log of commits
# cm: commit -m -> Record changes with an inline commit message
# a: add . -> Stage all changes in the current directory
# Note: These are just examples.
# You can define your own shortcuts, like setting `co` to `commit`.
git-alias:
co: checkout
br: branch
ci: commit
st: status
cm: commit -m
```
## Usage
### Define Your Git Aliases
Customize your Git Aliases by editing the `byul-alias.yml` file. Here’s an example configuration:
```yaml
git-alias:
co: checkout
br: branch
ci: commit
st: status
cm: commit -m
```
This setup ensures that your Git aliases are consistently applied across your project.
### Install and Apply Aliases
Once your Git Aliases are configured, install and apply them effortlessly with:
```bash
npx byul-alias install
npx byul-alias add
```
**Byul-alias** automatically configures and applies your Git aliases with ease.
## Contributing
We welcome contributions to **byul-alias**! Whether it's reporting a bug, suggesting an enhancement, or submitting a pull request, your input is valued.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contact
For any questions, suggestions, or feedback, please contact [love1ace](mailto:lovelacedud@gmail.com).