Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alex-shpak/gitname
Automatically set git config properties in local repository based on remote URL
https://github.com/alex-shpak/gitname
git
Last synced: about 10 hours ago
JSON representation
Automatically set git config properties in local repository based on remote URL
- Host: GitHub
- URL: https://github.com/alex-shpak/gitname
- Owner: alex-shpak
- License: mit
- Created: 2017-08-06T09:41:11.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-10-25T08:56:51.000Z (about 3 years ago)
- Last Synced: 2024-06-21T18:55:11.081Z (5 months ago)
- Topics: git
- Language: Go
- Homepage:
- Size: 24.4 KB
- Stars: 14
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gitname
Simple tool to set `user.name` and `user.email` or other properties in local git repository based on remote URL.
[](LICENSE)
[](https://goreportcard.com/report/github.com/alex-shpak/gitname)
## Use case
It is common to have multiple git repositories and platforms to work with. For example you might contribute OSS at `github.com` and have private organisation `github.com/private-organization` at your work, also some repositories at `gitlab.com`. So then you might want to use different email and/or config for these repositories.
Here is where this tool useful. When you run `gitname`, it will set local config in repository according to git remote. More specific URL has higher priority. See [configuration](#configure) for example.
## Install
### Homebrew
```sh
$ brew tap alex-shpak/gitname http://github.com/alex-shpak/gitname
$ brew install gitname
```
### Pre-compiled Binaries
You can download binary for your platform directly from [releases](https://github.com/alex-shpak/gitname/releases) page.
### Install from sources
```
$ go get -u github.com/alex-shpak/gitname
$ go install github.com/alex-shpak/gitname
```
## Configure
Add these lines to `.gitconfig` file into your home directory, modify where needed. You can use other global [git config files](https://git-scm.com/docs/git-config#FILES) as well.
```ini
[user "github.com"]
name = Alex Shpak
email = [email protected]
[user "github.com/private-organization"]
name = Alexander Shpak
email = [email protected]
signingKey = xxx
[user "gitlab.com"]
name = Alex Shpak
email = [email protected]
```
## Run
Navigate to target git repository and run `gitname`:
```
~/Projects/gitname » gitname
2019/10/11 21:14:54 Committing as Alex Shpak
```
You can set specific section by passing name of section as argument: `gitname github.com`, this comes useful when there is no remote yet.
You can also create handy alias.
```sh
$ git config --global alias.name '!gitname'
$ git name
```
## Unset globally configured name
Optionally run below commands to unset globally configured name and email and [prevent Git](https://git-scm.com/docs/git-config#git-config-useruseConfigOnly) from guessing them in newly cloned repositories.
```sh
$ git config --global user.name ""
$ git config --global user.email ""
$ git config --global user.useConfigOnly true
```