Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dominic-g/git-command-simplifier
Simplify Git interactions by reducing token and username typing in common operations.
https://github.com/dominic-g/git-command-simplifier
git git-repository
Last synced: 1 day ago
JSON representation
Simplify Git interactions by reducing token and username typing in common operations.
- Host: GitHub
- URL: https://github.com/dominic-g/git-command-simplifier
- Owner: dominic-g
- Created: 2023-08-05T13:49:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-08T19:46:58.000Z (over 1 year ago)
- Last Synced: 2023-08-08T20:57:49.129Z (over 1 year ago)
- Topics: git, git-repository
- Language: Shell
- Homepage:
- Size: 29.3 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Git Command Simplifier
This program provides a streamlined approach to interacting with Git repositories, reducing the need for repetitive typing of tokens and usernames during common Git operations. By utilizing this program, you can save time and enhance your development workflow.
## Features
1. **Efficient Commit and Push:**
Instead of the usual sequence of commands:
```
git add .
git commit -m "commit message"
git push
```
You can simply use:
```bash
push "commit message" (optional)
```
if the commit message you are using has no spaces ie its one word, then there is no need for quotes you can type
```
push commit
```
If you are in a hurry and do not want to keep writing the commit message just type
```
push
```
and the program will write the files affected and timestamp.
If the files edited, created and deleted are many,
the message will be clipped at 72 characters to meet [github commit message length requirement](https://www.gitkraken.com/learn/git/best-practices/git-commit-message#git-commit-message-structure).
**Note:** **__Kindly use a helpful commit message to help your team track the changes.__**
**__This feature is only added for when there is time limitations, otherwise try and use helpful commit messages.__**
2. **Cloning Repositories:**
Instead of writing:
```bash
git clone https://{token}@github.com/{username}/{repository}
```
You can use:
```bash
clone repository_name
```
3. **Pulling Changes:**
Replace ``` `git pull` ``` with:
```
pull
```
4. **Easy Token and Username Update:**
To update your token and username for different accounts/repositories, simply run:
```
github_token
```
This command will prompt you to enter the new token and username, making it easy to switch between different credentials.
## Installation
1. Clone the repository or download the files.
2. Navigate to the repository directory.
3. Ensure `install.sh` & `common_github.sh` scripts are executable if not run:
```
chmod +x install.sh common_github.sh
```
If you get the following error or similar messgae while running the script
```
bash: ./install.sh: Permission denied
```
**DO NOT** run it with super user access ~~`su`~~ just run the command above to make it executable
4. Install the `expect` package (if not already installed):
```
sudo apt-get install expect -y
```
5. Run the installation script:
```
./install.sh
```
If the installation fails due to permissions, ensure the scripts \(~install.sh~ & ~common_github.sh~\) are executable as mentioned in step 3.
**__NOTE:__**
1. You will be required to provide your github token if you haven't created one [see how to create a new token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
2. You need to give your github username as it appears on your link eg `https://github.com/user-name` the username should be `user-name`
3. For the Git config username and emails are used when commiting changes to display who made the changes.
**The config email and username are stored as global values and can be changed by running the `github_token` command input the token, username again and give different values for the config**
**__All the information asked are stored on the local machine and are not transmitted over the internet and are ONLY accessed by the local machine.__**
## Usage
Once installed, you can start using the simplified commands immediately:
- Push changes:
```
push "commit message" (optional)
```
- Clone a repository:
```
clone repository_name
```
- Pull changes:
```
pull
```
- Update token and username:
```
github_token
```
## Benefits
By using the Git Command Simplifier, you'll experience:
- Reduced development time by eliminating repetitive token and username entries.
- Enhanced security as your details are stored safely.
- Quick switching between different accounts and repositories.
Feel free to tailor this tool to your workflow and enjoy a more efficient Git experience!
---
**Note:** This tool requires the `expect` package. If you encounter issues during installation or usage, ensure that `expect` is properly installed.