Skip to content

Latest commit

 

History

History
262 lines (218 loc) · 13.4 KB

USER_HANDBOOK.md

File metadata and controls

262 lines (218 loc) · 13.4 KB

中文Git 用户手册

项目展示图

项目网站：[点我前往]

这是 中文Git 的用户手册，你可以在这里找到一些有关 中文Git 的使用方法。

如何获取

请前往仓库发行版页下载最新版中文Git。
如果你已有中文Git，只是希望更新，请查看条目如何更新中文Git。

使用 winget

你也可以使用 winget 来获取中文Git，请留意支持 winget 获取的版本。
使用以下命令安装:

winget install DuckStudio.ChineseGit

输出类似这样:
1718315176839

Tip

使用 winget 获取的不用配置Python。

Tip

设支持的版本号为n，则 $2.4 \leqslant n \leqslant 2.10$
winget会错误的将版本2.10显示为版本2.1，更多信息请见microsoft/winget-pkgs#196868

依赖

Git

在使用 中文Git 前，你必须先配置好 Git 。中文Git 只是一个帮你用中文命令来执行 Git 命令的工具，不能代替 Git 。
运行以下命令以检查：

git -v

如果输出类似于以下内容，则说明无需进行更改：

git version 2.47.1.windows.1

如果无法执行命令:

  • 未下载 Git
    请 下载Git 。
  • 已下载 Git
    请 将Git添加到环境变量 (方法可自行百度，添加完后若未起效请重启您的设备)

Python

如果你希望从源码 (中文git.py) 使用 中文Git ，请先配置好 Python。

运行以下命令以检查:

python --version

你可能会看到类似这样的输出：

C:\Users\user_name>python --version
Python 3.12.0

运行以下命令以安装所需库:

pip install -r requirements.txt

如果无法执行命令:

在您配置完这些依赖后，您应该就可以正常的使用 中文Git 了。
目前来看，你似乎可以使用 中文Git 的Python源码来在 Linux 和 macos 系统上运行 中文Git ，但是我没试过，所以不能保证稳定性。

如何使用

优化

每次都要输这么多的命令...烦死了。
我们来优化一下命令吧！

打包版

  1. 将程序目录添加到系统环境变量PATH中。
    类似的具体操作请参阅 [芙芙工具箱] Q：我该如何添加python到系统PATH环境变量
  2. 重启你的设备
  3. 验证
    运行以下命令以验证配置: 
    中文git 版本
    你应该会看到如下输出: 
    中文Git by 鸭鸭「カモ」
版本：v2.x
安装在: D:\...\Chinese_git\中文git.exe
git version 2.47.1.windows.1
    (版本不一样没关系)

源码

Warning

此方法可能仅对只传入一个参数时才有效，更多信息请见DuckDuckStudio/Fufu_Tools#97

  1. 新建一个文件夹，名称随意(这里假设叫Chinese_git_Script。很复杂也没事，反正命令用不到)
  2. 在文件夹中新建一个叫中文git.ps1的脚本，并在脚本中添加以下内容:
  • 对于 py版 :
param(
    [string]$command,
    [string[]]$inputArgs
)

python "D:\中文Git的完整路径\中文git.py" $command $inputArgs

Warning

如果你创建了虚拟Python环境，请将python改为虚拟环境中的python.exe。
示例:

param(
    [string]$command,
    [string[]]$inputArgs
)
$venv_python = "D:\虚拟环境路径\Scripts\python.exe"
$scriptPath = "D:\完整路径\中文git.py"
& $venv_python $scriptPath $command $inputArgs
  1. 将我们前面新建好的目录添加到系统环境变量PATH中。
    类似的具体操作请参阅 [芙芙工具箱] Q：我该如何添加python到系统PATH环境变量
  2. 重启你的设备
  3. 验证
    运行以下命令以验证配置: 
    中文git 版本
    你应该会看到如下输出: 
    中文Git by 鸭鸭「カモ」
版本：v2.x
安装在: D:\...\Chinese_git\中文git.py
git version 2.47.1.windows.1
    (版本不一样没关系)

这样，你就可以不用在每次执行 中文Git 时都使用完整路径了，您只需使用以下代码即可:

中文git 命令

请将命令替换为你需要执行的 中文Git 的命令，详细可用命令请查看下方的 可用命令 条目

可用命令

以下是 中文Git 目前的可用命令，如需添加更多命令请提交 Issues 或者 PR
关于如何贡献，请查看CONTRIBUTING文件。

Tip

这里的可用命令为仓库中最新版本的可用命令，每个Releases的可用命令请查看对应的tag的README/README_DEV/USER_HANDBOOK。
例如(v1.8的可用命令):
https://github.com/DuckDuckStudio/Chinese_git/blob/v1.8/USER_HANDBOOK.md#可用命令

在中文Git中的命令 在Git中的命令 用途
拉取 pull 从远程仓库拉取源码 (git文档)
推送 push 将本地仓库中的提交推送到远程仓库中 (git文档)
提交 commit -m 提交您的更改
新建分支 checkout -b 创建一个全新的分支
切换分支 / 签出到 checkout 切换到另一个分支 (git文档)
合并 merge 合并分支（可能会产生冲突） (git文档)
变基 rebase 变基合并分支（可能会产生冲突） (git文档)
暂存 add 暂存您的修改以备提交 (git文档)
状态 status 查看当前仓库状态 (git文档)
日志 log 查看提交日志 (git文档)
删除分支 (+确认) branch -D(-d) 删除指定分支(+合并检查)
远程地址 remote -v 查看远程仓库地址
远程分支 branch -r 查看远程仓库的分支列表
所有分支 branch -a 查看仓库的所有分支列表
版本 -v 显示中文Git版本和Git版本
克隆 clone 克隆远程仓库到本地 (git文档)
图形化日志 log --graph 查看图形化的提交日志
是否忽略 check-ignore -v 检查文件/文件夹是否被.gitignore忽略
初始化 init 初始化一个新的 Git 仓库 (git文档)
本地分支 (+最新提交 +与上游分支关系) branch (-v/-vv) 列出所有本地分支(+最新提交 +与上游分支关系)
强推 push --force 将本地仓库的提交强制推送到远程仓库中
更名分支 branch -m 修改本地仓库分支名
更新 / 更新 中文Git
还原 revert 还原某些现有提交 (git文档)
重置 (+保留更改(默认)/+删除更改) reset (--mixed/--hard) 移动 HEAD 指针以及修改暂存区和工作目录中的文件状态
公告 / 显示中文Git版本的最新公告
差异 diff 显示提交和工作区等变化 (git文档)
清理引用 remote prune origin 清除在远程仓库中不存在的分支
清理 clean 删除工作目录树中未跟踪的文件 (git文档)
配置 config 获取和设置仓库或全局选项 (git文档)

Note

对于提交命令，如果提交信息带空格请用"将提交信息括起来
对于新建分支命令，该命令会在新建完分支后自动签出到新分支

如何更新

  • 对于v1.6及以下版本:
    把你旧的 中文Git 删掉换成新的 中文Git 就行。
  • 对于v1.7-v2.3版本:
    • py版
      运行命令中文git 更新。
    • 打包版
      把你旧的 中文Git 删掉换成新的 中文Git 就行。
  • 对于v2.4及以上版本:
    运行命令中文git 更新。

Tip

如果 winget 上有可用的新版本的话，你也可以试试这个命令:

winget update --id DuckStudio.ChineseGit

Note

如果你使用v2.4及以上版本的打包版中文Git，则你可以cd到安装目录后运行.\Pack_Version_Update.exe --version vx.y手动更新中文Git到指定版本，请将命令中的vx.y替换为你需要更新到的版本。

配置文件说明

默认配置文件 (v2.9) 如下:

{
    "information": {
        "version": "v2.9"
    },
    "application": {
        "notice": {
            "time": "",
            "level": "",
            "content": ""
        },
        "run": {
            "auto_check_update": "True",
            "auto_get_notice": "True"
        }
    }
}
  • information → 关于程序与配置文件的信息
    • version → 配置文件对应的程序版本 (暂未使用)
  • application → 关于程序的设置
    • notice → 关于公告的信息 (暂未使用)
      • time → 最新公告的发布时间 (暂未使用)
      • level → 最新公告的等级 (暂未使用)
      • content → 最新公告的内容 (暂未使用)
    • run → 关于运行时的设置
      • auto_check_update → 是否在每次执行完命令后都检查更新 (默认为True，不为True时不自动检查) - 禁用该功能可大幅提升运行速度，但将失去自动更新检查功能
      • auto_get_notice → 是否在每次执行完命令后都获取最新公告 (默认为True，不为True时不自动获取) - 禁用该功能可大幅提升运行速度，但将失去自动公告获取

已知问题

请见Issues页。

关于编码

中文Git 的所有项目文件源码以及发行版文件均使用 UTF-8 编码，如出现乱码请使用 UTF-8 编码而非简体中文系统默认的 GBK 编码。