stolt/git-user-bend

用于管理Git用户配置的实用工具。

v1.5.1 2024-07-22 16:07 UTC

This package is auto-updated.

Last update: 2024-09-23 08:16:25 UTC


README

Test Version PHP Version

git-user-bend CLI是一个用于管理给定Git仓库(即名称和电子邮件)的Git用户配置的实用工具。使用它,您可以创建一组角色,并在进行公司工作、开源开发或结对编程会话时轻松地切换它们。

使用Git 2.13中引入的条件配置包含,您可以为一组仓库设置一个.gitconfig,这可能已经满足您的需求。

已知相关

此CLI受到Gas Ruby gem的影响,并可能包含pair的一些元素。

安装

应通过Composer全局安装git-user-bend CLI。

composer global require stolt/git-user-bend

请确保您的全局供应商二进制目录路径已添加到您的$PATH。您可以通过composer global config bin-dir --absolute确定全局供应商二进制目录的位置。这样就可以找到git-user-bend可执行文件。

由于CLI的默认名称相当长,可以在~/.aliases~/.zshrc等文件中放置一个别名,这可能很有用。下面的别名假设$COMPOSER_HOME~/.config/composer而不是~/.composer

alias gub='~/.config/composer/vendor/bin/git-user-bend $@'

提示

从版本v1.2.1开始,也可以通过PHAR 文件安装和使用git-user-bend

用法

在Git仓库(或参数化的一个)中运行git-user-bend whoami CLI,它将允许您查看当前使用的角色或Git用户配置的详细信息。

角色及其使用频率存储在系统$HOME目录中的基于JSON的全球存储文件.gub.personas中。

通过.gub点文件,还可以将单个角色的详细信息直接添加到项目仓库中。这主要面向在多台机器上使用多个角色的仓库维护者。为了保护您的电子邮件地址,请考虑使用您的username@users.noreply.github.com电子邮件地址,有关详细信息,请参阅在Git中设置电子邮件

可用命令

要创建新角色,可以使用add命令。它允许您定义与角色详细信息(即用户名和电子邮件)链接的别名。添加的每个角色都存储在全局存储文件中。

git-user-bend add <alias> <name> <email>
git-user-bend add "oss" "Raphael Stolt" "raphaelstolt@users.noreply.github.com"
git-user-bend add "com" "Raphael Stolt" "raphael.stolt@company.com"

要使用本地.gub点文件、本地Git仓库用户详细信息或全局Git用户详细信息创建角色,可以使用import命令。当应从Git用户详细信息创建角色时,必须提供其别名。

git-user-bend import [<alias>] [<directory>] [--from-dotfile]

要创建从现有角色创建的本地.gub点文件,可以使用export命令。

git-user-bend export <alias> [<directory>]

要使用全局存储从定义的角色中删除,可以使用retire命令。

git-user-bend retire <alias>

要查看所有定义的角色,可以使用personas命令。通过--edit|-e选项,可以通过定义的$EDITOR编辑名为.gub.personas的全局存储文件。

git-user-bend personas [--edit|-e]

要弯曲 Git 仓库的化身,可以使用 use 命令来更改 Git 用户配置为别名用户的详细信息。当使用 --from-dotfile 选项时,会使用定义在 .gub 配置文件中的化身。当应使用全局存储中的别名化身时,必须提供其别名。当应使用一对化身时,必须以逗号分隔的列表形式提供它们的别名。

git-user-bend use [<alias>|<alias1,aliasN>] [<directory>] [--from-dotfile]

要重置 Git 仓库用户到之前的值,可以使用 reset 命令。

git-user-bend reset [<directory>]

要开始一个双人编程会话,该会话将在 Git 提交中识别,可以使用 pair 命令将几个化身的用户详细信息合并成一个对。逗号分隔列表中的第一个化身别名的电子邮件将被用于 Git 的 user.email 配置。如果提供了 --branch|-b,将创建一个新的 Git 分支以进行配对。

git-user-bend pair "<alias1,aliasN>" [<directory>] [--branch|-b]

要结束双人编程会话并恢复默认的 user.nameuser.email,可以使用 unpair 命令。

git-user-bend unpair <directory>

要检查化身、对或相应地检查仓库的 Git 用户配置,可以使用 whoami 命令,这是一个便捷的快捷方式。

git-user-bend whoami [<directory>]

运行测试

composer test

许可证

本库及其 CLI 在 MIT 许可证下授权。有关更多详细信息,请参阅 LICENSE.md

变更日志

有关更多详细信息,请参阅 CHANGELOG.md

行为准则

有关更多详细信息,请参阅 CONDUCT.md

贡献

有关更多详细信息,请参阅 CONTRIBUTING.md