Skip to content

Latest commit

 

History

History
112 lines (80 loc) · 3.89 KB

README.md

File metadata and controls

112 lines (80 loc) · 3.89 KB
Raw

git-user

Software License GoDoc Build Status Coverage Report

Git plugin that allows you to save multiple user profiles and set them as project defaults

Why?

I created this because I have multiple emails that I use for work, personal, and open source projects and I would find myself checking into a git project with the wrong profile. Instead of manually changing the git config for a project every time, this was much easier.

Installing

Compile

This project requires go1.18+ to compile. Just run go install github.com/gesquive/git-user@latest and the executable should be built for you automatically in your $GOPATH.

Optionally you can run make install to build and copy the executable to /usr/local/bin/ with correct permissions.

Download

Alternately, you can download the latest release for your platform from github.

Once you have an executable, make sure to copy it somewhere on your path like /usr/local/bin or C:/Program Files/. If on a *nix/mac system, make sure to run chmod +x /path/to/git-user.

Homebrew

This app is also avalable from this homebrew tap. Just install the tap and then the app will be available.

$ brew tap gesquive/tap
$ brew install git-user

Usage

If the git-user executable is placed on the path, it can be used as a git command. For example, you would be able to run the command git user list to list all of the configured users.

git-user lets you quickly switch between multiple git user profiles

Usage:
  git-user [flags] [command]

Available Commands:
  add         Add a new profile
  del         Delete a profile
  edit        Edit a profile
  list        List all saved profiles
  rm          Remove a profile from the current project
  set         Set the profile for the current project

Flags:
  -c, --config string     config file (default "~/.git-profiles")
  -g, --git-path string   The git executable to use (default "git")
  -p, --path string       The project to get/set the user (default "$CWD")
  -V, --version           Show the version and exit

Optionally, a hidden debug flag is available in case you need additional output.

Hidden Flags:
  -D, --debug                  Include debug statements in log output

QuickStart

$ cd /path/to/git/project

# add a work profile for Henry
$ git user add work "Dr. Henry Jekyll" henry@jekyll.com
Added profile 'work'

# add a personal profile for Edward
$ git user add home "Edward Hyde" hyde@night.com
Added profile 'home'

# list out our saved profiles
$ git user list
Global Profile:
  User: Henry <hjekyll@gmail.com>

Saved Profiles:
  home: Edward Hyde <hyde@night.com>
  work: Dr. Henry Jekyll <henry@jekyll.com>

# set the current git repository user to the home profile
$ git user set home
The user for the 'project' repository has been set too 'Edward Hyde <hyde@night.com>'

# list profiles again, notice how the current repository profile is now set
$ git user
Project Profile:
  Path: /path/to/git/project
  User: Edward Hyde <hyde@night.com>

Saved Profiles:
  home: Edward Hyde <hyde@night.com>
  work: Dr. Henry Jekyll <henry@jekyll.com>

Documentation

This documentation can be found at github.com/gesquive/git-user

License

This package is made available under an MIT-style license. See LICENSE.

Contributing

PRs are always welcome!