https://github.com/ryanlarge13/git-shorthands
Initializing a repo to keep track of the scripts created for Linux terminals. Eventually to create an entire CLI to manage git repos even easier and help developers stay away from repetitive tasks.
https://github.com/ryanlarge13/git-shorthands
bash-script git
Last synced: 3 months ago
JSON representation
Initializing a repo to keep track of the scripts created for Linux terminals. Eventually to create an entire CLI to manage git repos even easier and help developers stay away from repetitive tasks.
- Host: GitHub
- URL: https://github.com/ryanlarge13/git-shorthands
- Owner: RyanLarge13
- Created: 2022-11-25T17:22:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-17T17:32:14.000Z (almost 2 years ago)
- Last Synced: 2025-04-04T09:41:38.937Z (over 1 year ago)
- Topics: bash-script, git
- Language: Shell
- Homepage:
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Git Shorts (gs)
**Git Shorts** is a lightweight command‑line helper that wraps common Git workflows into short, memorable commands using a single entry point: `gs`.
Stop typing long git commands and start shipping faster.
---
## 🚀 Features
| Command | Description |
| ---------------------------- | ----------------------------------------------------------------------------- |
| `gs clone ` | Clone one of your GitHub repositories. |
| `gs clone ` | Clone another user's repository. |
| `gs init ` | Initialize a new repository, optionally create README.md, and push to GitHub. |
| `gs commit` | Stage all changes, commit, and push. |
| `gs -p` | Pull latest changes. |
| `gs -m` | Merge branches interactively. |
| `gs -s` | Show `git status`. |
| `gs conf` | Update local configuration (username, installer). |
| `gs -v` | Show the currently installed version. |
| `gs -h` or `gs -H` | View help. |
---
## ✅ Key Benefits
* Fast repo cloning with automatic dependency installation
* Quickly initialize repos and push to GitHub in one step
* Useful merge / pull / commit wrappers
* Automatically persists username + package installer
* Built‑in colored help output for quick reference
---
## 📦 Installation
1. Download `gs` (this script).
2. Place it somewhere in your PATH, for example:
```bash
mv gs /usr/local/bin/gs
chmod +x /usr/local/bin/gs
```
3. (Optional) Export the function for shell use:
```bash
export -f gs
```
---
## 🧠 Setup
The first time you run any `gs` command, you will be guided through a one‑time setup:
* GitHub username
* Preferred package installer (`npm`, `pnpm`, `bun`, etc.)
This information is stored in:
```
~/.gitshorts_config
```
To update your config at any time:
```bash
gs conf
```
---
## 🌱 Examples
Clone one of *your* repos and install dependencies:
```bash
gs clone my-repo
```
Clone someone else's repo:
```bash
gs clone cool-library torvalds
```
Create a new repo, commit, push, and generate README.md:
```bash
gs init my-new-project
```
Commit everything and push:
```bash
gs commit
```
---
## 🔧 Config File
Stored at: `~/.gitshorts_config`
Example:
```
USERNAME=yourGitHubName
INSTALLER=npm
```
---
## 🛠 Requirements
* Bash
* Git installed and configured
* SSH access to GitHub
---
## 🤝 Contributing
Feel free to fork the repo and submit PRs.
Bug reports / ideas welcome.
---
## 📄 License
MIT License. Use freely and break things.
---
**Happy coding!** ✨
```
gs commit
# literally all you need
```