133 lines
3.6 KiB
Markdown
133 lines
3.6 KiB
Markdown
# QuickGit 使用说明
|
||
|
||
**⚠️ 重要提示：本工具仅支持通过 SSH 方式连接 GitHub 和 Gitea 远程仓库，不支持 HTTPS。**
|
||
|
||
## 前置要求
|
||
|
||
### 必需配置 SSH 密钥
|
||
1. 生成 SSH 密钥：
|
||
```bash
|
||
ssh-keygen -t ed25519 -C "your_email@example.com"
|
||
```
|
||
|
||
2. 将公钥添加到 GitHub/Gitea：
|
||
- GitHub: Settings → SSH and GPG keys → New SSH key
|
||
- Gitea: 设置 → SSH/GPG 密钥 → 添加密钥
|
||
|
||
3. 测试连接：
|
||
```bash
|
||
ssh -T git@github.com
|
||
ssh -T git@git.shumengya.top -p 8022
|
||
```
|
||
|
||
## 已修复的问题
|
||
|
||
### 1. 添加文件失败问题
|
||
- **原因**: Windows系统上创建了错误的`nul`文件
|
||
- **解决**: 已删除并修复批处理脚本的输出重定向
|
||
|
||
### 2. 界面对齐问题
|
||
- **原因**: 使用了Unicode矩形边框字符在不同终端宽度不一致
|
||
- **解决**: 改用简单的`=`和`-`线条，确保所有终端都能完美对齐
|
||
|
||
## 新界面特色
|
||
|
||
### 彩色输出方案
|
||
- **标题**: 亮青色、亮品红色
|
||
- **成功**: 亮绿色 `[√]`
|
||
- **错误**: 亮红色 `[×]`
|
||
- **信息**: 亮青色 `[i]`
|
||
- **警告**: 亮黄色 `[!]`
|
||
- **运行中**: 亮青色 `[>]`
|
||
|
||
### 简洁分割线
|
||
```
|
||
============================================================ (标题线)
|
||
------------------------------------------------------------ (分割线)
|
||
```
|
||
|
||
### 紧凑布局
|
||
- 减少不必要的空行
|
||
- 信息排列紧密
|
||
- 重要内容突出显示
|
||
|
||
## 运行方式
|
||
|
||
### Windows (推荐)
|
||
双击运行 `run.bat` - 自动设置UTF-8编码
|
||
|
||
### 任何系统
|
||
```bash
|
||
python quickgit.py
|
||
```
|
||
|
||
## 界面预览
|
||
|
||
```
|
||
============================================================
|
||
QuickGit - 萌芽一键Git管理工具 v1.0
|
||
============================================================
|
||
当前目录: E:\SmyProjects\Python\脚本\萌芽一键Git管理
|
||
Git状态: [已初始化]
|
||
------------------------------------------------------------
|
||
|
||
>> 主菜单
|
||
------------------------------------------------------------
|
||
[1] 初始化Git仓库
|
||
[2] 提交更改到本地
|
||
[3] 推送到远程仓库
|
||
[4] 从远程仓库拉取
|
||
[5] 查看仓库状态
|
||
[6] 管理远程仓库
|
||
[7] 退出程序
|
||
------------------------------------------------------------
|
||
[*] 提交代码前建议先拉取最新代码，减少代码冲突
|
||
[*] 使用SSH进行Git提交更方便快捷和安全
|
||
------------------------------------------------------------
|
||
>> 请输入选项 [1-7]:
|
||
```
|
||
|
||
## 功能说明
|
||
|
||
所有功能均正常工作：
|
||
- ✓ 初始化Git仓库
|
||
- ✓ 提交更改到本地（不推送）
|
||
- ✓ 推送到远程仓库（通过 SSH）
|
||
- ✓ 从远程仓库拉取（通过 SSH）
|
||
- ✓ 查看仓库状态
|
||
- ✓ 管理远程仓库（GitHub/Gitea/自建 Git，仅 SSH）
|
||
- ✓ 配置 Gitea 服务器（自定义主机和端口）
|
||
- ✓ 添加自建 Git 仓库（GitLab、自建 Gitea、Gogs 等）
|
||
|
||
### 远程仓库管理菜单
|
||
```
|
||
[1] 查看远程仓库
|
||
[2] 添加GitHub远程仓库
|
||
[3] 添加Gitea远程仓库
|
||
[4] 添加自建Git仓库 ← 新功能
|
||
[5] 配置Gitea服务器 ← 新功能
|
||
[6] 删除远程仓库
|
||
[7] 返回主菜单
|
||
```
|
||
|
||
### 远程仓库 URL 格式
|
||
- **GitHub**: `git@github.com:shumengya/{repo}.git`
|
||
- **Gitea**: `ssh://git@git.shumengya.top:8022/{user}/{repo}.git`
|
||
- 主机和端口可通过菜单配置
|
||
- **自建 Git**: 支持自定义 SSH URL
|
||
- GitLab: `git@gitlab.com:user/repo.git`
|
||
- 自建服务器: `ssh://git@your-server.com:port/user/repo.git`
|
||
|
||
**注意**：不支持 HTTPS URL 格式（如 `https://github.com/user/repo.git`）
|
||
|
||
### 配置文件
|
||
配置保存在：`~/.quickgit_config.json`
|
||
|
||
可配置项：
|
||
- Gitea 主机地址
|
||
- Gitea SSH 端口
|
||
- GitHub 用户名
|
||
- 默认分支名
|
||
|
||
界面美观、对齐完美、功能稳定！
|