posh-git 项目技术文档

1. 安装指南

前提条件

在安装 posh-git 之前，请确保满足以下前提条件：

1. PowerShell 版本：Windows PowerShell 5.x 或 PowerShell Core 6.0 及以上版本。可以通过执行 $PSVersionTable.PSVersion 来检查 PowerShell 版本。
2. 脚本执行策略：在 Windows 上，脚本执行策略必须设置为 RemoteSigned 或 Unrestricted。可以通过执行 Get-ExecutionPolicy 来检查当前策略。如果策略不符合要求，请以管理员身份运行 PowerShell 并执行 Set-ExecutionPolicy RemoteSigned -Scope CurrentUser -Confirm。
3. Git 安装：Git 必须已安装并通过 PATH 环境变量可用。可以通过在 PowerShell 中执行 git --version 来验证 Git 是否可用。如果 Git 未安装，可以从 Git 官网 下载并安装。

安装方式

通过 PowerShellGet 安装

posh-git 可以通过 PowerShell Gallery 安装。执行以下命令进行安装：

# 如果你从未安装过 posh-git
PowerShellGet\Install-Module posh-git -Scope CurrentUser -Force

或者

# 如果你已经安装了旧版本的 posh-git
PowerShellGet\Update-Module posh-git

通过 Chocolatey 安装

如果你使用 Chocolatey 包管理器，可以通过以下命令安装 posh-git：

choco install poshgit

通过 Scoop 安装

如果你使用 Scoop 包管理器，可以通过以下命令安装 posh-git：

scoop bucket add extras
scoop install posh-git
Add-PoshGitToProfile

手动安装

如果你需要手动安装 posh-git，可以通过以下命令导入模块：

Import-Module <path-to-src\posh-git.psd1>

例如，如果你将 posh-git 克隆到 ~\git\posh-git，可以通过以下命令导入：

Import-Module ~\git\posh-git\src\posh-git.psd1

2. 项目的使用说明

导入 posh-git

安装完成后，你需要在 PowerShell 会话中导入 posh-git 模块以启用 Git 的 Tab 补全功能。可以通过以下命令导入模块：

Import-Module posh-git

配置 PowerShell 自动导入

为了避免每次打开新的 PowerShell 会话时手动导入模块，可以将导入命令添加到 PowerShell 配置文件中。可以通过以下命令实现：

Add-PoshGitToProfile

或者手动编辑 PowerShell 配置文件，添加以下内容：

Import-Module posh-git

保存配置文件后，关闭并重新打开 PowerShell 会话，posh-git 将自动加载。

3. 项目API使用文档

posh-git 提供了 Git 状态摘要信息，并在 PowerShell 提示符中显示。默认的 Git 状态摘要格式如下：

[{HEAD-name} S +A ~B -C !D | +E ~F -G !H W]

• {HEAD-name}：当前分支名称或 detached HEAD 的 SHA。
  • 蓝色表示分支与远程分支匹配。
  • 绿色表示分支领先于远程分支（可以推送）。
  • 红色表示分支落后于远程分支。
  • 黄色表示分支既领先又落后于远程分支。
• S：表示分支与远程分支的关系。
  • ≡：本地分支与远程分支处于同一提交级别。
  • ↑<num>：本地分支领先于远程分支。

4. 项目安装方式

posh-git 可以通过多种方式安装，包括：

• PowerShellGet：通过 PowerShell Gallery 安装。
• Chocolatey：通过 Chocolatey 包管理器安装。
• Scoop：通过 Scoop 包管理器安装。
• 手动安装：通过手动导入模块进行安装。

选择适合你的安装方式，并按照相应的步骤进行操作。