Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arzkar/git-utils
A CLI for performing various operations on git repositories
https://github.com/arzkar/git-utils
bulk git go utils
Last synced: 2 months ago
JSON representation
A CLI for performing various operations on git repositories
- Host: GitHub
- URL: https://github.com/arzkar/git-utils
- Owner: arzkar
- License: apache-2.0
- Created: 2023-06-02T10:30:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-07T15:01:08.000Z (about 1 year ago)
- Last Synced: 2024-05-21T09:08:06.369Z (8 months ago)
- Topics: bulk, git, go, utils
- Language: Go
- Homepage:
- Size: 50.8 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
git-utils
[](https://ko-fi.com/arzkar)
A CLI for performing various operations on git repositories
## Features
- `pull`: Pull branches for all the repositories at once.
- `fetch`: Fetch branches for all the repositories at once.
- `grep`: Search for a pattern in file contents across multiple repositories.
- `checkout`: Checkout a branch for all the repositories at once.
- `tag`: Use custom tag messages for git repositories
- `bump`: Version bump the version
# Installation
## Using Go
```
go install github.com/arzkar/git-utils@latest
```
## From Github
1. Make sure you have Git installed on your system.
2. Download the latest release of Git Utils from the [Releases](https://github.com/arzkar/git-utils/releases) page.
3. Extract the downloaded archive to a location of your choice.
4. Add the extracted directory to your system's PATH.
# Usage
```
> git-utils
git-utils v0.5.1
Copyright (c) Arbaaz Laskar
A CLI for performing various operations on git repositories
Usage:
git-utils [command]
Available Commands:
bump Version bump the version
checkout Checkout a branch in all repositories
completion Generate the autocompletion script for the specified shell
fetch Fetch all or specified branches
grep Search for a pattern in files
help Help about any command
pull Pull all or specified branches
tag Create a new tag with a custom message for the repository
Flags:
--config Show app config
-h, --help help for git-utils
Use "git-utils [command] --help" for more information about a command.
```
# Example
## Note
- You can specify the optional `--dir` flag to search within a specific directory. By default, the current directory is used.
- Use the `--config` flag to show the location of the app directory and config file
- For pull & fetch commands, you can specify a single branch, a comma seperated list of branches or all.
### Pull
The `pull` command allows you to update your local branch with the latest changes for all the repositories at once.
Command:
`git-utils pull [--dir=]`
Example:
`git-utils pull main,devel`
### Fetch
The `fetch` command fetches the latest changes for all the repositories at once.
Command:
`git-utils fetch [--dir=]`
Example:
`git-utils fetch feature-branch`
### Checkout
The `checkout` command allows you to switch between branches for all the repositories at once.
Command:
`git-utils checkout [--dir=]`
Example:
`git-utils checkout develop`
### Grep
The `grep` command searches for a specified pattern in the files of all the repositories at once.
Command:
`git-utils grep [--dir=]`
Example:
`git-utils grep "TODO"`
### Tag
The `tag` command reads the config file and uses custom message for tag
Command:
`git-utils tag -a -m `
Example:
`git-utils tag -a "v0.1.2" -m "changelog"`
Sample `config.json`:
```json
{
"tags": {
"messages": {
"changelog": "Full changelog: https://github.com/{repo_owner}/{repo_name}/compare/{prevTag}...{newTag}"
}
}
}
```
Tag Templates variables available: `repo_owner, repo_name, prevTag, newTag`
### Bump
The `bump` command bumps the version set in the `.git-utils-bump.cfg` and search & replaces the version for the files set in the config file using the subcommands: `major`, `minor` & `patch`
Command:
`git-utils bump `
Example:
`git-utils bump minor`
Sample `.git-utils.bump.cfg:
```yml
[bumpversion]
current_version = 0.4.0
commit = True
tag = True
tag_format = v{tag}
[bumpversion:file:cmd/root.go]
search = git-utils v{current_version}
replace = git-utils v{new_version}
[bumpversion:file:README.md]
search = git-utils v{current_version}
replace = git-utils v{new_version}
[bumpversion:file:utils/update_checker.go]
search = v{current_version}
replace = v{new_version}
```