https://github.com/b4nd/git-profile
Git Profile is a CLI tool that streamlines managing multiple Git identities, letting you effortlessly create, update, and switch between profiles.
https://github.com/b4nd/git-profile
cli email git manager managers profile profiles username
Last synced: 2 months ago
JSON representation
Git Profile is a CLI tool that streamlines managing multiple Git identities, letting you effortlessly create, update, and switch between profiles.
- Host: GitHub
- URL: https://github.com/b4nd/git-profile
- Owner: b4nd
- License: mit
- Created: 2025-02-02T17:20:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-24T00:59:42.000Z (over 1 year ago)
- Last Synced: 2025-02-24T01:26:24.605Z (over 1 year ago)
- Topics: cli, email, git, manager, managers, profile, profiles, username
- Language: Go
- Homepage: https://github.com/b4nd/git-profile
- Size: 3.55 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Git Profile
[](https://www.repostatus.org/#active)
[](https://opensource.org/licenses/MIT)
[](https://github.com/b4nd/git-profile/actions/workflows/build.yml)
[](https://goreportcard.com/report/github.com/b4nd/git-profile)
[](https://codecov.io/gh/b4nd/git-profile)
[](https://github.com/b4nd/git-profile/releases/latest)
[](https://somsubhra.github.io/github-release-stats/?username=b4nd&repository=git-profile)
[](https://app.codacy.com/gh/b4nd/git-profile/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://app.codacy.com/gh/b4nd/git-profile/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
#### SonarCloud
[](https://sonarcloud.io/summary/new_code?id=b4nd_git-profile)
[](https://sonarcloud.io/summary/new_code?id=b4nd_git-profile)
[](https://sonarcloud.io/summary/new_code?id=b4nd_git-profile)
[](https://sonarcloud.io/summary/new_code?id=b4nd_git-profile)
[](https://sonarcloud.io/summary/new_code?id=b4nd_git-profile)
[](https://sonarcloud.io/summary/new_code?id=b4nd_git-profile)
[](https://sonarcloud.io/summary/new_code?id=b4nd_git-profile)
[](https://sonarcloud.io/summary/new_code?id=b4nd_git-profile)
[](https://sonarcloud.io/summary/new_code?id=b4nd_git-profile)
## Overview
Git Profile is a command-line application developed in Go, designed to efficiently manage multiple Git profiles. It provides a suite of commands to create, update, delete, and switch between different user profiles, making it easier to handle various identities across diverse Git repositories. The commands also feature an interactive mode that prompts you for the necessary details, simplifying the setup process. This tool is particularly useful for developers who work on multiple projects with different user credentials.
### Example Use Case
Imagine a developer working on both open-source and corporate projects. They need to switch between different Git profiles seamlessly to ensure commits are associated with the correct email and username. Instead of manually changing Git configurations every time, they can use `git profile` to quickly switch between predefined profiles, improving workflow efficiency.
Once you’ve configured a project profile,`git profile` will remember it the next time you work on that project, saving you the hassle of reconfiguration.
#### Profile Storage
By default,`git profile` stores profiles in `$HOME/.gitprofile`. However, you can also store them locally by using the `--local` flag, which places a `.gitprofile` file in the current folder. This feature is especially useful for keeping project-specific settings right inside the repository.
#### Where the selected profile is stored
git profile uses the .git/config file in each repository to store the selected profile. This way, there’s no need to reconfigure the profile every time you work on that repository, and it also ensures that the local name and user remain consistent for each project.
## Commands Documentation
| Command | Alias | Flags | Description |
| ------------------------- | --------- | ----------------------- | ---------------------------------------------------------- |
| `git profile current` | | `--global`,`--verbose` | Displays the currently active profile. |
| `git profile delete` | `del` | `--local` | Deletes a specified profile from the system. |
| `git profile get` | | `--local`,`--verbose` | Retrieves details of a specific profile. |
| `git profile list` | `ls` | `--local`,`--verbose` | Lists all available profiles. |
| `git profile add` | `create` | `--local` | Sets or updates a profile configuration. |
| `git profile set` | `use` | `--global` | Switches to a specific profile for operations. |
| `git profile unset` | `unuse` | `--global` | Unsets the currently active profile. |
| `git profile amend` | | | Updates email and name of the current profile last commit. |
| `git profile version` | | | Displays the current version of the application. |
| `git profile help` | | | Displays help information for the application. |
### Flags
- `--local` flag: Specifies that the operation should be performed on the local `.gitprofile` file.
- `--global` flag: Specifies that the operation should be performed on the global `.gitconfig` file.
- `--verbose` flag: Displays additional information about the current profile.
## Installation
### Linux
```bash
curl -sL https://github.com/b4nd/git-profile/releases/download/v0.1.5/git-profile-v0.1.5-linux-amd64 -o git-profile
chmod +x git-profile
mv git-profile /usr/local/bin/
```
### macOS
```bash
curl -sL https://github.com/b4nd/git-profile/releases/download/v0.1.5/git-profile-v0.1.5-darwin-amd64 -o git-profile
chmod +x git-profile
mv git-profile /usr/local/bin/
```
### Windows
1. Download the latest Windows executable from the [releases page](https://github.com/b4nd/git-profile/releases).
2. Extract the archive.
3. Move the `git-profile-v0.1.5-darwin-amd64.exe` file to a directory in your system `PATH` and rename it to `git-profile.exe`.
4. Optionally, add the directory to the system `PATH` environment variable for easier access.
```powershell
[System.Environment]::SetEnvironmentVariable("Path", $Env:Path + ";C:\\path\\to\\git-profile", [System.EnvironmentVariableTarget]::User)
```
## Usage
To use the application, run the following command:
```bash
git profile [command] [flags]
```
### More Examples
- **Create a new profile for a personal project:**
```bash
git profile add personal --name "Your Name" --email "name@example.com"
```
This command add up a new profile named `personal` with the given credentials.
- **List all existing profiles:**
```bash
git profile list
```
Displays all available profiles currently stored.
- **Set a specific profile:**
```bash
git profile set personal
```
Switches to the `personal` profile, applying its Git credentials.
- **Check the currently active profile:**
```bash
git profile current
```
Shows which profile is currently in use.
- **Check the global current profile:**
```bash
git profile current --global
```
equivalent to `git config --global user.name` and `git config --global user.email`
- **Amend the last commit with the active profile's details:**
```bash
git profile amend
```
Updates the latest commit with the email and name of the currently active profile.
- **Unset the currently active profile:**
```bash
git profile unset
```
Removes the currently active profile, reverting to the default Git configuration.
- **Unset global current profile:**
```bash
git profile unset --global
```
equivalent to `git config --global --unset user.name` and `git config --global --unset user.email`
- **Remove a profile:**
```bash
git profile delete personal
```
Deletes the `personal` profile.
## Environment variables
| Variable | Description |
| ------------------ | ----------------------------------------------------------------------------------------- |
| `GIT_PROFILE_PATH` | The path to the directory where the profiles are stored. Default is `$HOME/.gitprofile`. |
### Configuring GIT\_PROFILE\_PATH in `.zshrc` or `.bashrc`
If you want to specify a custom location for the Git Profile configuration, you can set the `GIT_PROFILE_PATH` environment variable in your shell configuration file.
For Windows Subsystem for Linux (WSL), you can add the following lines to your `~/.zshrc` or `~/.bashrc`:
```bash
# Example of a shared Git profile on Windows through WSL
export GIT_PROFILE_PATH="/mnt/c/Users//.gitprofile"
```
After adding the line, apply the changes by running:
```bash
source ~/.zshrc # If using zsh
source ~/.bashrc # If using bash
```
## DevContainer Support
This project includes support for **DevContainers**, allowing developers to quickly set up a consistent development environment using **VS Code Remote - Containers** or **GitHub Codespaces**.
### How to Use
1. Ensure you have **Docker** installed and running.
2. Open the project in **VS Code**.
3. Install the **Dev Containers** extension if you haven't already.
4. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P` on macOS) and select `Remote-Containers: Reopen in Container`.
This will automatically set up all dependencies and configurations needed for development.
## Requirements
- [Go](https://golang.org/) v1.23.6
- [Taskfile](https://taskfile.dev/) v3.41.0
- [golangci-lint](https://golangci-lint.run/) v1.63.4
- [gosec](https://github.com/securego/gosec/) v2.22.0
- [Git](https://git-scm.com/)
## Build
1. Clone the repository:
```bash
git clone https://github.com/b4nd/git-profile.git
```
2. Change into the project directory:
```bash
cd git-profile
```
3. Install the dependencies:
```bash
go mod tidy
```
4. Run the tests:
```bash
task test
```
5. Run the following command to install the application:
```bash
task build
```
build output will be in the `bin` directory.
## Example usage during development
Below are examples of how to use each command, along with explanations of their purpose:
- **Set a new profile:**
```bash
task run -- add \
--workspace company \
--name "Your Name" \
--email "name@example.com"
```
This command creates a new Git profile under the workspace `company`, assigning the specified name and email.
- **List all profiles:**
```bash
task run -- list
```
Displays all available Git profiles configured in the system.
- **Switch to a specific profile:**
```bash
task run -- set company
```
Activates the Git profile associated with `company`, ensuring that subsequent Git commits use the corresponding credentials.
- **Check the currently active profile:**
```bash
task run -- current
```
Shows the details of the currently active Git profile, including name and email.
## Contributing
1. Fork the repository.
2. Create a new branch:
```bash
git checkout -b feature-name
```
3. Commit your changes:
```bash
git commit -m 'Add new feature'
```
4. Push to the branch:
```bash
git push origin feature-name
```
5. Open a pull request.
## Authors
- [Juan Manuel Garcia](https://github.com/b4nd/me)
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Acknowledgements
[](https://sonarcloud.io/summary/new_code?id=b4nd_git-profile)