Compare commits

...

6 Commits

Author SHA1 Message Date
3af0c0dcc8 增加兼容性 2026-02-17 18:05:30 +08:00
e78e33731b update: 2026-02-17 17:42:11 2026-02-17 17:42:11 +08:00
e8d607c602 替换自建git地址 2026-02-17 17:21:04 +08:00
e8697e3676 update: 2026-02-16 00:49:09 2026-02-16 00:49:09 +08:00
d6fbdf16e3 update: 2026-02-16 00:43:38 2026-02-16 00:43:38 +08:00
6973a327e4 update: 2026-02-16 00:34:56 2026-02-16 00:34:56 +08:00
10 changed files with 996 additions and 259 deletions

View File

@@ -13,6 +13,7 @@ This document provides coding agents with essential information about the QuickG
- Standard library only: `subprocess`, `os`, `datetime`, `sys`
- Cross-platform support: Windows, Linux, macOS
- ANSI escape codes for colorful console output
- **SSH-only Git operations**: Supports GitHub and Gitea via SSH (no HTTPS support)
---
@@ -37,21 +38,32 @@ python mengya_git_manager.py
**No formal test suite exists yet.** Manual testing workflow:
1. **Test in a clean directory:**
1. **Prerequisite: Configure SSH keys**
```bash
# Generate SSH key if needed
ssh-keygen -t ed25519 -C "your_email@example.com"
# Test SSH connection
ssh -T git@github.com
ssh -T git@git.shumengya.top -p 8022
```
2. **Test in a clean directory:**
```bash
cd /path/to/test/directory
python E:\SmyProjects\Python\脚本\萌芽一键Git管理\quickgit.py
```
2. **Test each menu option:**
3. **Test each menu option:**
- Option 1: Initialize Git repo
- Option 2: Commit and push (requires changes)
- Option 3: Pull from remote
- Option 4: View status
- Option 5: Manage remotes
- Option 6: Exit
- Option 2: Commit changes to local (requires changes)
- Option 3: Push to remote (requires SSH-configured remote)
- Option 4: Pull from remote (requires SSH-configured remote)
- Option 5: View status
- Option 6: Manage remotes (add GitHub/Gitea via SSH)
- Option 7: Exit
3. **Verify console output:**
4. **Verify console output:**
- Check colors render correctly
- Ensure ASCII dividers align (60 chars wide)
- No encoding errors with Chinese characters
@@ -240,10 +252,17 @@ OutputFormatter.menu_item(1, "Option") # [1] Menu item
### SSH Configuration
- **GitHub:** `git@github.com:shumengya/{repo}.git`
- **Gitea:** `ssh://git@repo.shumengya.top:8022/{user}/{repo}.git`
**⚠️ IMPORTANT: This tool ONLY supports SSH connections. HTTPS is not supported.**
All remote operations use SSH (no HTTPS).
- **GitHub:** `git@github.com:shumengya/{repo}.git`
- **Gitea:** `ssh://git@git.shumengya.top:8022/{user}/{repo}.git`
All remote operations (push, pull, fetch) use SSH. Do not use HTTPS URLs like `https://github.com/user/repo.git`.
**Prerequisites:**
1. User must have SSH keys generated (`ssh-keygen`)
2. Public key must be added to GitHub/Gitea account
3. SSH connection must be tested and working
### Command Execution

122
CLAUDE.md Normal file
View File

@@ -0,0 +1,122 @@
# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## Project Overview
QuickGit (萌芽一键Git管理工具) is a Python CLI tool that simplifies Git operations through an interactive menu interface. It supports managing multiple Git repositories, handles both GitHub and Gitea remotes, and provides cross-platform compatibility (Windows, Linux, macOS).
## Running the Application
**Windows:**
```bash
run.bat # Recommended - sets UTF-8 encoding
python quickgit.py # Direct execution
```
**Linux/macOS:**
```bash
./run.sh # Recommended (requires chmod +x run.sh first time)
python3 quickgit.py # Direct execution
```
The tool is interactive - no command-line arguments needed. On startup, it prompts for a Git repository directory to manage.
## Architecture
The codebase follows a modular design with clear separation of concerns:
### Module Hierarchy
```
quickgit.py (entry point)
└── ui.py (GitManagerUI)
├── git_operations.py (GitOperations)
├── remote_manager.py (RemoteManager)
├── utils.py (CommandExecutor, OutputFormatter, InputValidator, PlatformUtils)
└── config.py (Config)
```
### Key Design Patterns
**1. Utility Classes Pattern** (`utils.py`)
- `CommandExecutor`: Centralized subprocess execution with UTF-8 handling
- `OutputFormatter`: Consistent colored console output (success/error/info/warning/step)
- `InputValidator`: User input validation and directory path handling
- `PlatformUtils`: Cross-platform operations (clear screen, path normalization, platform detection)
- `Colors`: ANSI color code definitions
**2. Operations Layer** (`git_operations.py`)
- `GitOperations` class manages all Git commands
- Maintains working directory state (`self.current_dir`)
- All Git operations use `CommandExecutor` for consistency
- Methods return `tuple[bool, str]` for success status and output
**3. Remote Management** (`remote_manager.py`)
- Handles GitHub and Gitea remote repository configuration
- GitHub format: `git@github.com:shumengya/{repo}.git`
- Gitea format: `ssh://git@git.shumengya.top:8022/{user}/{repo}.git`
- Manages multiple remotes per repository
**4. Configuration** (`config.py`)
- Centralized configuration in `Config` class
- Gitea server: `git.shumengya.top:8022`
- GitHub user: `shumengya`
- Default branch: `main`
- Includes comprehensive `.gitignore` template for Node.js, Go, Python projects
### Cross-Platform Considerations
The codebase handles platform differences through `PlatformUtils`:
- Path normalization with `os.path.expanduser()` and `os.path.normpath()`
- Platform detection: `is_windows()`, `is_linux()`, `is_mac()`
- Clear screen: `cls` (Windows) vs `clear` (Unix)
- Python command: `python` (Windows) vs `python3` (Unix)
- UTF-8 encoding explicitly set in subprocess calls
### State Management
- `GitOperations` maintains `self.current_dir` for the working directory
- Directory can be changed via `change_directory()` method
- All Git commands execute in the context of `self.current_dir`
- UI layer (`ui.py`) orchestrates state between operations and remote management
## Important Implementation Details
**Commit Message Format:**
- Default format: `update: YYYY-MM-DD HH:MM:SS` (see `git_operations.py:145`)
- Generated using `datetime.now().strftime('%Y-%m-%d %H:%M:%S')`
**Git Initialization Workflow:**
1. Run `git init`
2. Create `main` branch with `git checkout -b main`
3. Create `.gitignore` from template
4. Initial commit with message "first commit"
**Push Strategy:**
- First attempts direct push: `git push {remote} {branch}`
- If fails, retries with upstream: `git push -u {remote} {branch}`
- This handles first-time pushes to new remotes
**Subprocess Execution:**
- All commands use `shell=True` for compatibility
- UTF-8 encoding with `errors='ignore'` for robustness
- Captures both stdout and stderr combined
- Returns `(success: bool, output: str)` tuple
## Configuration Customization
To modify default settings, edit `quickgit/config.py`:
- `GITEA_HOST` and `GITEA_PORT`: Gitea server details
- `GITHUB_USER`: Default GitHub username
- `DEFAULT_BRANCH`: Default branch name (currently "main")
- `GITIGNORE_TEMPLATE`: Template for auto-generated .gitignore files
## Testing Considerations
When testing or modifying Git operations:
- Test with both existing and non-existing repositories
- Verify cross-platform path handling (Windows backslashes vs Unix forward slashes)
- Test with repositories that have/don't have remotes configured
- Verify UTF-8 handling for commit messages with non-ASCII characters
- Test the push retry logic (direct push → upstream push fallback)

357
GitHub_SSH_故障排查.md Normal file
View File

@@ -0,0 +1,357 @@
# GitHub SSH 连接问题诊断与解决方案
**⚠️ QuickGit 工具说明:** 本工具目前仅支持 SSH 方式连接远程仓库,不支持 HTTPS。本文档中提到的 HTTPS 方案仅适用于手动使用 `git` 命令行操作,不适用于 QuickGit 工具本身。
---
## 问题现象
```
Connection closed by 198.18.0.66 port 22
fatal: Could not read from remote repository.
```
这个错误表明 SSH 连接被关闭,可能的原因包括:
1. SSH 密钥未正确配置
2. SSH 密钥未添加到 GitHub
3. 网络问题或代理设置
4. SSH 配置文件问题
---
## 诊断步骤
### 第 1 步:检查 SSH 密钥是否存在
**Windows:**
```bash
dir %USERPROFILE%\.ssh
```
**Linux/macOS:**
```bash
ls -la ~/.ssh
```
**应该看到:**
- `id_rsa``id_rsa.pub` (RSA 密钥)
-`id_ed25519``id_ed25519.pub` (Ed25519 密钥,推荐)
---
### 第 2 步:如果没有 SSH 密钥,生成新密钥
**推荐方式 (Ed25519):**
```bash
ssh-keygen -t ed25519 -C "your_email@example.com"
```
**传统方式 (RSA):**
```bash
ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
```
**执行过程:**
```
Generating public/private ed25519 key pair.
Enter file in which to save the key (/home/user/.ssh/id_ed25519): [直接回车]
Enter passphrase (empty for no passphrase): [可以直接回车或输入密码]
Enter same passphrase again: [重复密码]
```
---
### 第 3 步:查看公钥内容
**Windows:**
```bash
type %USERPROFILE%\.ssh\id_ed25519.pub
# 或
type %USERPROFILE%\.ssh\id_rsa.pub
```
**Linux/macOS:**
```bash
cat ~/.ssh/id_ed25519.pub
# 或
cat ~/.ssh/id_rsa.pub
```
**复制输出的完整内容**,类似:
```
ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIM... your_email@example.com
```
---
### 第 4 步:添加公钥到 GitHub
1. **登录 GitHub**: https://github.com
2. **打开设置**: 点击右上角头像 → Settings
3. **SSH 和 GPG 密钥**: 左侧菜单 → SSH and GPG keys
4. **添加新密钥**: 点击 "New SSH key" 按钮
5. **填写信息:**
- Title: 给密钥起个名字My Windows PC
- Key: 粘贴第3步复制的公钥内容
6. **保存**: 点击 "Add SSH key"
---
### 第 5 步:测试 SSH 连接
```bash
ssh -T git@github.com
```
**成功的输出:**
```
Hi username! You've successfully authenticated, but GitHub does not provide shell access.
```
**如果仍然失败,继续下一步...**
---
## 常见问题与解决方案
### 问题 1: Connection closed by 198.18.0.66
这个 IP 地址 `198.18.0.66` 不是 GitHub 的官方 IP可能是
- 代理服务器
- VPN
- 公司网络的网关
**解决方案:检查代理设置**
#### 方案 A: 配置 Git 使用代理
如果您在使用代理,需要配置:
```bash
# HTTP 代理
git config --global http.proxy http://proxy_server:port
git config --global https.proxy https://proxy_server:port
# SOCKS5 代理
git config --global http.proxy socks5://proxy_server:port
```
#### 方案 B: 取消代理设置
```bash
git config --global --unset http.proxy
git config --global --unset https.proxy
```
#### 方案 C: 为 SSH 配置代理
创建或编辑 `~/.ssh/config` 文件:
**Windows:** `C:\Users\YourName\.ssh\config`
**Linux/macOS:** `~/.ssh/config`
```
Host github.com
HostName github.com
User git
# 如果使用 HTTP 代理
ProxyCommand connect -H proxy_server:port %h %p
# 如果使用 SOCKS5 代理
# ProxyCommand connect -S proxy_server:port %h %p
```
---
### 问题 2: Permission denied (publickey)
**原因:** SSH 密钥未被识别
**解决方案:**
1. **启动 SSH Agent:**
```bash
# Windows (Git Bash)
eval "$(ssh-agent -s)"
# Linux/macOS
eval "$(ssh-agent -s)"
```
2. **添加私钥到 SSH Agent:**
```bash
ssh-add ~/.ssh/id_ed25519
# 或
ssh-add ~/.ssh/id_rsa
```
3. **再次测试连接:**
```bash
ssh -T git@github.com
```
---
### 问题 3: 防火墙阻止 SSH 端口 22
**解决方案 A: 使用 HTTPS 代替 SSH**
修改远程仓库 URL
```bash
# 查看当前 URL
git remote -v
# 修改为 HTTPS
git remote set-url origin https://github.com/shumengya/QuickGit.git
```
**缺点:** 每次推送需要输入用户名和密码(或 Token
**解决方案 B: 使用 SSH over HTTPS (端口 443)**
编辑 `~/.ssh/config`:
```
Host github.com
HostName ssh.github.com
Port 443
User git
```
测试:
```bash
ssh -T -p 443 git@ssh.github.com
```
---
### 问题 4: SSH 密钥格式错误
**原因:** Windows 换行符问题或复制时引入了额外字符
**解决方案:**
1. **重新生成密钥**(推荐)
2. **或确保公钥完整且格式正确**
---
## QuickGit 用户的完整解决流程
### 步骤 1: 生成 SSH 密钥
```bash
# Windows (Git Bash 或 PowerShell)
ssh-keygen -t ed25519 -C "shumengya@example.com"
# 一路回车即可
```
### 步骤 2: 复制公钥
```bash
# Windows
type %USERPROFILE%\.ssh\id_ed25519.pub
# Linux/macOS
cat ~/.ssh/id_ed25519.pub
```
### 步骤 3: 添加到 GitHub
1. 访问 https://github.com/settings/keys
2. 点击 "New SSH key"
3. 粘贴公钥,保存
### 步骤 4: 测试连接
```bash
ssh -T git@github.com
```
**期望输出:**
```
Hi shumengya! You've successfully authenticated...
```
### 步骤 5: 在 QuickGit 中重新配置远程仓库
如果之前的远程仓库配置有问题:
```bash
# 删除旧的 github 远程仓库
git remote remove github
# 重新添加
git remote add github git@github.com:shumengya/QuickGit.git
# 验证
git remote -v
```
### 步骤 6: 使用 QuickGit 推送
1. 启动 QuickGit
2. 选择 `[2] 提交更改到本地` - 提交到本地仓库
3. 选择 `[3] 推送到远程仓库` - 推送到 `github`(通过 SSH
---
## 调试命令
如果问题仍然存在,使用以下命令获取详细信息:
```bash
# 详细模式测试 SSH 连接
ssh -vT git@github.com
# 查看 Git 配置
git config --list
# 查看远程仓库配置
git remote -v
# 手动推送(查看详细错误)
git push -v github main
```
---
## 快速修复:改用 HTTPS仅适用于 git 命令行)
**⚠️ 重要:** 以下 HTTPS 方案仅适用于手动使用 `git` 命令行操作,**QuickGit 工具本身不支持 HTTPS**。
如果 SSH 问题难以解决,可以临时使用命令行的 HTTPS 方式:
```bash
# 修改远程仓库 URL
git remote set-url github https://github.com/shumengya/QuickGit.git
# 推送(需要输入用户名和密码/Token
git push github main
```
**注意:** HTTPS 方式需要:
- GitHub 用户名
- Personal Access Token不能使用密码
**生成 Token:**
1. GitHub → Settings → Developer settings → Personal access tokens → Tokens (classic)
2. Generate new token
3. 勾选 `repo` 权限
4. 复制 Token只显示一次
**再次强调:** QuickGit 工具不支持 HTTPS 远程仓库,必须使用 SSH。如果需要使用 HTTPS请直接使用 `git` 命令行工具。
---
## 总结
**推荐解决方案顺序(用于 QuickGit:**
1. ✅ 生成 SSH 密钥
2. ✅ 添加公钥到 GitHub
3. ✅ 测试 SSH 连接
4. ✅ 配置 SSH Agent如果需要
5. ⚠️ 检查代理设置(如果在公司网络)
6. ⚠️ 使用 SSH over HTTPS端口 443作为备选
**注意:** QuickGit 工具不支持 HTTPS 方式,必须解决 SSH 连接问题才能正常使用。如果实在无法配置 SSH建议直接使用 `git` 命令行工具配合 HTTPS。

404
README.md
View File

@@ -1,255 +1,241 @@
# QuickGit - 萌芽一键Git管理工具
一个简单易用的模块化Git命令行管理工具让Git操作更加便捷高效
一个纯 Python 3.6+、零外部依赖的彩色 CLI 工具,用模块化方式把常用 Git 操作"一键化",支持 Windows / Linux / macOS
## 功能特性
**⚠️ 重要说明:** 本工具目前仅支持通过 **SSH 方式**连接 GitHub 和 Gitea 远程仓库,不支持 HTTPS 方式。使用前请确保已配置 SSH 密钥。
- **灵活的目录管理** - 启动时可选择任意Git仓库目录进行管理
- **一键初始化Git仓库** - 自动完成Git初始化、分支创建、.gitignore配置
- **一键提交推送** - 快速提交代码并推送到远程仓库
- **多仓库支持** - 同时支持GitHub和Gitea仓库管理
- **远程仓库管理** - 便捷地添加、删除、查看远程仓库
- **状态查看** - 快速查看仓库状态和提交历史
- **彩色界面** - 友好的彩色控制台输出
- **模块化设计** - 易于维护和扩展
- **跨平台支持** - 完美兼容 Windows、Linux、macOS
- **智能路径处理** - 自动处理不同平台的路径格式
## 1) 项目简介与核心卖点
- 模块化架构,功能职责清晰,易扩展。
- 无三方依赖,直接随 Python 运行。
- 跨平台路径与编码适配,默认分支 `main`
- 彩色输出 + ASCII 分隔线,兼顾可读性与兼容性。
- **SSH 优先策略**:仅支持 SSH 连接,更安全、更便捷。
## 项目结构
## 2) 功能清单
- [x] 灵活目录选择(启动时可管理任意仓库)
- [x] 初始化仓库(创建分支、生成 `.gitignore`
- [x] 提交更改(提交到本地仓库)
- [x] 推送更改(推送到远程仓库,支持多远程选择,**仅支持 SSH**
- [x] 从远程拉取(**仅支持 SSH**
- [x] 远程仓库管理GitHub / Gitea / 自建 Git 服务器,**仅支持 SSH 方式**
- [x] **可配置 Gitea 服务器**(自定义主机地址和端口)
- [x] **自建 Git 仓库支持**GitLab、自建 Gitea、Gogs 等)
- [x] 状态查看(工作区状态 + 最近提交)
- [ ] 分支管理
- [ ] 标签管理
- [ ] 冲突解决辅助
- [ ] 批量处理多个仓库
- [ ] HTTPS 支持(未来版本)
## 3) 项目结构
```
QuickGit/
├── quickgit/ # 核心模块
│ ├── __init__.py # 包初始化
│ ├── config.py # 配置模块
│ ├── utils.py # 工具类(命令执行、输出格式化、输入验证、平台工具
│ ├── git_operations.py # Git操作模块
│ ├── remote_manager.py # 远程仓库管理模块
│ └── ui.py # UI交互模块
├── quickgit.py # 主程序入口
├── run.bat # Windows启动脚本
├── run.sh # Linux/macOS启动脚本
├── mengya_git_manager.py # 旧版单文件脚本(兼容保留)
└── README.md # 项目文档
│ ├── __init__.py
│ ├── config.py # 常量与 .gitignore 模板
│ ├── utils.py # 颜色、输出、命令执行、输入校验、平台工具
│ ├── git_operations.py # init / add / commit / push / pull / status
│ ├── remote_manager.py # 远程管理GitHub/Gitea
│ └── ui.py # 交互与菜单
├── quickgit.py # 主入口(模块化版本)
├── run.bat # Windows 启动脚本UTF-8
├── run.sh # Linux/macOS 启动脚本(需 chmod +x
├── mengya_git_manager.py # 旧版单文件脚本(兼容保留)
└── README.md
```
## 快速开始
## 4) 快速开始
### 运行脚本
### 前置要求
1. **必需**:已安装 Git 和 Python 3.6+
2. **必需**:已配置 SSH 密钥并添加到 GitHub/Gitea 账户
3. **推荐**:使用支持 ANSI 颜色的终端Windows Terminal、PowerShell、iTerm2 等)
### SSH 密钥配置指南
如果你还没有配置 SSH 密钥,请按以下步骤操作:
**Windows:**
```bash
# 使用启动脚本自动设置UTF-8编码
run.bat
# 1. 生成 SSH 密钥(如果还没有
ssh-keygen -t ed25519 -C "your_email@example.com"
# 或直接运行
# 2. 查看公钥内容
cat ~/.ssh/id_ed25519.pub # Linux/macOS
type %USERPROFILE%\.ssh\id_ed25519.pub # Windows
# 3. 将公钥添加到远程仓库
# - GitHub: Settings -> SSH and GPG keys -> New SSH key
# - Gitea: 设置 -> SSH/GPG 密钥 -> 添加密钥
# 4. 测试连接
ssh -T git@github.com # 测试 GitHub
ssh -T git@git.shumengya.top -p 8022 # 测试 Gitea
```
### 启动程序
**Windows**
```bash
run.bat
# 或
python quickgit.py
```
**Linux/macOS:**
**Linux / macOS**
```bash
# 首次使用需要添加执行权限
chmod +x run.sh
# 使用启动脚本(推荐)
./run.sh
# 或直接运行
# 或
python3 quickgit.py
```
**通用方式:**
```bash
# 新版模块化脚本(推荐)
python quickgit.py
# 或使用旧版单文件脚本
python mengya_git_manager.py
```
### 主要功能菜单
**首次启动时:**
- 选择要管理的Git仓库目录
- 支持绝对路径和相对路径
- 直接回车使用脚本所在目录
- 自动验证目录是否存在
**主菜单选项:**
## 5) 交互流程
- 启动即要求选择工作目录:支持绝对/相对路径,直接回车使用脚本所在目录,自动校验目录存在。
- 主菜单(含永久提示):
```
[1] 初始化Git仓库
[2] 提交并推送更改
[3] 远程仓库拉取
[4] 查看仓库状态
[5] 管理远程仓库
[6] 退出程序
小提示:
[2] 提交更改到本地
[3] 推送到远程仓库
[4] 从远程仓库拉取
[5] 查看仓库状态
[6] 管理远程仓库
[7] 退出程序
[*] 提交代码前建议先拉取最新代码,减少代码冲突
[*] 使用SSH进行Git提交更方便快捷和安全
```
## 使用场景
## 6) 常用操作示例
### 场景0选择工作目录
### 场景0: 选择工作目录
- 启动时输入要管理的仓库路径
- 支持绝对路径、相对路径、`~` 路径
- 直接回车使用当前目录
启动脚本后,首先会要求选择工作目录:
### 场景1: 初始化新仓库
1. 选择 [1] 初始化Git仓库
2. 自动创建 `.gitignore`(含前端/后端通用规则)
3. 自动创建 `main` 分支并进行首次提交
4. 选择 [6] 管理远程仓库 → 添加 GitHub 或 Gitea 远程仓库(**仅 SSH**
**Windows示例**
```
请输入要管理的Git仓库目录 (回车使用当前目录: E:\Projects\MyApp):
输入: C:\Users\YourName\project
或: .\myproject (相对路径)
或: 直接回车使用默认目录
### 场景2: 日常提交工作流
1. 选择 [2] 提交更改到本地
- 查看更改的文件
- 输入提交信息(留空自动填入时间戳)
- 代码提交到本地仓库
2. 选择 [3] 推送到远程仓库
- 选择远程仓库(可多选)
- 通过 SSH 推送到远程
### 场景3: 拉取远程更新
1. 选择 [4] 从远程仓库拉取
2. 选择远程仓库(单选)
3. 通过 SSH 拉取当前分支的更新
### 场景4: 管理远程仓库
选择 [6] 管理远程仓库,提供以下功能:
#### 4.1 添加 GitHub 远程仓库
SSH 格式:`git@github.com:shumengya/{repo}.git`
#### 4.2 添加 Gitea 远程仓库
SSH 格式:`ssh://git@git.shumengya.top:8022/{user}/{repo}.git`
默认使用配置的 Gitea 服务器地址和端口,可通过"配置 Gitea 服务器"修改。
#### 4.3 添加自建 Git 仓库
支持添加自定义 Git 服务器GitLab、自建 Gitea、Gogs 等):
1. 输入远程仓库名称(如:`gitlab``mygit`
2. 输入完整的 SSH URL
3. 支持的 URL 格式示例:
- `git@gitlab.com:user/repo.git`
- `ssh://git@your-server.com:port/user/repo.git`
#### 4.4 配置 Gitea 服务器
自定义 Gitea 服务器的主机地址和 SSH 端口:
- 默认主机:`git.shumengya.top`
- 默认端口:`8022`
- 配置保存在:`~/.quickgit_config.json`
#### 4.5 其他功能
- **查看所有远程仓库** - 显示已配置的远程仓库列表
- **删除远程仓库** - 移除不需要的远程仓库
**⚠️ 注意:** 本工具不支持 HTTPS URL 格式(如 `https://github.com/user/repo.git`),仅支持 SSH 格式。
### 场景5: 配置文件
QuickGit 的配置文件保存在:`~/.quickgit_config.json`
**配置内容:**
```json
{
"gitea_host": "git.shumengya.top",
"gitea_port": "8022",
"github_user": "shumengya",
"default_branch": "main"
}
```
**Linux/macOS示例**
```
请输入要管理的Git仓库目录 (回车使用当前目录: /home/user/quickgit):
输入: /home/yourname/project
或: ./myproject (相对路径)
或: ~/project (使用~表示用户目录)
或: 直接回车使用默认目录
```
**修改方式**
- 通过菜单:[6] 管理远程仓库 → [5] 配置 Gitea 服务器
- 或手动编辑配置文件(需重启工具生效)
### 场景1初始化新项目
## 7) 跨平台与终端要求
- `run.bat` 自动设置 UTF-8Windows 使用 `python` 命令。
- `run.sh` 设置 `LANG/LC_ALL`,首次需 `chmod +x run.sh`Linux/macOS 使用 `python3`
- 终端需支持 ANSI 颜色;仅使用 ASCII 符号,避免编码错位。
1. 运行脚本,输入项目目录路径(或直接回车使用当前目录)
2. 选择 `1. 初始化Git仓库`
3. 按提示配置GitHub或Gitea远程仓库
4. 完成首次提交
## 8) 控制台输出规范
- 分隔线宽度固定 60`======` / `------` / `·····`
- 禁止使用 emoji 和 Unicode 盒线字符。
- 颜色键值:成功绿、错误红、信息青、警告黄、标题青/品红。
- 状态/提示图标:`[√] [×] [i] [!] [>] [*]`
### 场景2提交代码更改
## 9) 手动测试清单
- 启动脚本:`run.bat``run.sh`、直接运行 `python/ python3 quickgit.py`
- 颜色与中文显示正常,分隔线对齐 60 列。
- 初始化仓库、提交+推送、拉取、远程管理均可用。
- 默认分支 `main``.gitignore` 自动写入成功。
1. 运行脚本选择要管理的Git仓库目录
2. 选择 `2. 提交并推送更改`
3. 输入提交信息(或使用默认信息)
4. 选择推送到哪个远程仓库
## 10) 常见问题 / 故障排查
### 场景3拉取远程更新
### SSH 相关问题
- **推送/拉取失败 "Permission denied (publickey)"**
- 确认 SSH 密钥已生成:`ls ~/.ssh/id_*.pub` (Linux/macOS) 或 `dir %USERPROFILE%\.ssh\id_*.pub` (Windows)
- 确认公钥已添加到 GitHub/Gitea 账户
- 测试 SSH 连接:`ssh -T git@github.com``ssh -T git@git.shumengya.top -p 8022`
- **"Could not resolve hostname"**
- 检查网络连接
- 确认远程仓库地址格式正确SSH 格式,非 HTTPS
- **端口被防火墙拦截**
- GitHub 使用标准 SSH 端口 22
- Gitea 使用自定义端口 8022确保防火墙允许此端口
1. 运行脚本选择要管理的Git仓库目录
2. 选择 `3. 从远程仓库拉取`
3. 选择要拉取的远程仓库
### 远程仓库相关
- **不支持 HTTPS URL**:本工具仅支持 SSH 方式,如果你的远程仓库使用 HTTPS URL`https://github.com/user/repo.git`),请手动改为 SSH 格式或使用 `git remote` 命令修改。
### 场景4管理多个项目
1. 每次运行脚本都可以选择不同的项目目录
2. 无需在项目目录中运行脚本
3. 一个工具管理所有Git项目
## 远程仓库配置
### GitHub配置
- 使用SSH方式连接
- 格式:`git@github.com:shumengya/{仓库名}.git`
### Gitea配置
- 服务器地址:`repo.shumengya.top:8022`
- 使用SSH方式连接
- 格式:`ssh://git@repo.shumengya.top:8022/{用户名}/{仓库名}.git`
## .gitignore 支持
脚本自动创建的 `.gitignore` 文件支持以下项目类型:
- **Node.js/React** - node_modules/, build/, dist/
- **Go** - *.exe, *.test, vendor/
- **Python** - __pycache__/, venv/, *.pyc
- **通用** - 日志文件、临时文件、IDE配置
## 系统要求
- **Python:** 3.6+ (Linux/macOS 使用 python3)
- **Git:** 已安装并配置
- **SSH密钥:** 已配置(用于远程仓库推送)
- **操作系统:** Windows、Linux、macOS 均支持
### 平台特定说明
**Windows:**
- 建议使用 `run.bat` 启动自动配置UTF-8编码
- 控制台需支持ANSI颜色代码Windows 10+自带支持)
**Linux/macOS:**
- 使用 `python3` 命令运行
- 确保终端支持UTF-8编码和颜色显示
- 首次使用 `run.sh` 需要添加执行权限:`chmod +x run.sh`
## 注意事项
1. 首次使用前请确保已配置Git用户信息
```bash
git config --global user.name "你的名字"
git config --global user.email "你的邮箱"
```
2. 使用SSH方式连接需要提前配置SSH密钥
3. 推送到Gitea时请确保仓库已在服务器上创建
4. **重要提示:** 提交代码前建议先拉取最新代码,减少代码冲突
- 先执行 `3. 从远程仓库拉取`
- 再执行 `2. 提交并推送更改`
## 常见问题
**Q: 推送失败怎么办?**
A: 请检查SSH密钥配置和远程仓库地址是否正确
**Q: 如何切换远程仓库?**
A: 使用 `5. 管理远程仓库` 功能添加或删除远程仓库
**Q: 支持哪些Git操作**
A: 目前支持init、add、commit、push、pull等常用操作
## 模块说明
### config.py - 配置模块
存储所有配置信息包括Gitea服务器地址、GitHub用户名、.gitignore模板等。
### utils.py - 工具类模块
- `Colors`: 控制台颜色定义
- `CommandExecutor`: 命令执行器
- `OutputFormatter`: 输出格式化器
- `InputValidator`: 输入验证器
- `PlatformUtils`: 跨平台工具(清屏、平台检测)
### git_operations.py - Git操作模块
提供Git基本操作功能
- 初始化仓库
- 检查状态
- 添加/提交更改
- 推送/拉取代码
### remote_manager.py - 远程仓库管理模块
管理GitHub和Gitea远程仓库
- 添加/删除远程仓库
- 查看远程仓库列表
- 选择推送/拉取目标
### ui.py - UI交互模块
处理用户界面和交互逻辑,整合所有功能模块。
## 开发计划
### 终端显示问题
- **终端乱码**:设置 UTF-8Windows 可 `chcp 65001`Linux/macOS 确保 `LANG/LC_ALL` 为 UTF-8
- **颜色不显示**:使用支持 ANSI 的终端Windows Terminal/PowerShell 等)。
- **找不到 `python3`**:在 Linux/macOS 安装或创建软链接Windows 使用 `python`
## 11) 路线图
- [x] 模块化架构重构
- [ ] 支持分支管理
- [ ] 支持标签管理
- [ ] 支持冲突解决辅助
- [ ] 支持自定义配置文件
- [ ] 支持批量操作多个仓库
- [x] SSH 方式支持GitHub + Gitea
- [x] 可配置 Gitea 服务器
- [x] 自建 Git 仓库支持GitLab、自建 Gitea 等)
- [x] 配置文件持久化
- [ ] HTTPS 方式支持
- [ ] 分支管理
- [ ] 标签管理
- [ ] 冲突解决辅助
- [ ] 批量操作多个仓库
- [ ] 更多 Git 托管平台支持Bitbucket 等)
## 许可证
## 12) 许可证与作者
- 许可证MIT
- 作者shumengya
MIT License
## 作者
shumengya
---
**让Git操作更简单让开发更高效**
让 Git 操作更简单,让开发更高效!

View File

View File

@@ -2,16 +2,99 @@
配置模块 - 存储项目配置信息
"""
import os
import json
class Config:
"""配置类"""
# Gitea服务器配置
GITEA_HOST = "repo.shumengya.top"
GITEA_PORT = "8022"
# 配置文件路径
CONFIG_FILE = os.path.join(os.path.expanduser("~"), ".quickgit_config.json")
# GitHub配置
GITHUB_USER = "shumengya"
# 默认配置
_defaults = {
"gitea_host": "git.shumengya.top",
"gitea_port": "8022",
"github_user": "shumengya",
"default_branch": "main"
}
# 运行时配置(从文件加载或使用默认值)
_config = None
@classmethod
def _load_config(cls):
"""加载配置文件"""
if cls._config is not None:
return
if os.path.exists(cls.CONFIG_FILE):
try:
with open(cls.CONFIG_FILE, 'r', encoding='utf-8') as f:
cls._config = json.load(f)
except Exception:
cls._config = cls._defaults.copy()
else:
cls._config = cls._defaults.copy()
@classmethod
def _save_config(cls):
"""保存配置到文件"""
cls._load_config()
try:
with open(cls.CONFIG_FILE, 'w', encoding='utf-8') as f:
json.dump(cls._config, f, indent=2, ensure_ascii=False)
return True
except Exception:
return False
@classmethod
def get(cls, key: str, default=None):
"""获取配置项"""
cls._load_config()
return cls._config.get(key, default)
@classmethod
def set(cls, key: str, value):
"""设置配置项"""
cls._load_config()
cls._config[key] = value
cls._save_config()
# 属性访问器(保持向后兼容)
@property
def GITEA_HOST(self) -> str:
return self.get("gitea_host", self._defaults["gitea_host"])
@property
def GITEA_PORT(self) -> str:
return self.get("gitea_port", self._defaults["gitea_port"])
@property
def GITHUB_USER(self) -> str:
return self.get("github_user", self._defaults["github_user"])
@property
def DEFAULT_BRANCH(self) -> str:
return self.get("default_branch", self._defaults["default_branch"])
# 类方法访问器(用于类级别访问)
@classmethod
def get_gitea_host(cls) -> str:
return cls.get("gitea_host", cls._defaults["gitea_host"])
@classmethod
def get_gitea_port(cls) -> str:
return cls.get("gitea_port", cls._defaults["gitea_port"])
@classmethod
def get_github_user(cls) -> str:
return cls.get("github_user", cls._defaults["github_user"])
@classmethod
def get_default_branch(cls) -> str:
return cls.get("default_branch", cls._defaults["default_branch"])
# Git配置
DEFAULT_BRANCH = "main"

View File

@@ -46,7 +46,8 @@ class RemoteManager:
from .utils import Colors
repo_name = InputValidator.get_input(f"{Colors.BRIGHT_CYAN}>> 请输入GitHub仓库名: {Colors.ENDC}")
remote_url = f"git@github.com:{Config.GITHUB_USER}/{repo_name}.git"
github_user = Config.get_github_user()
remote_url = f"git@github.com:{github_user}/{repo_name}.git"
return self._add_remote("github", remote_url)
@@ -68,10 +69,97 @@ class RemoteManager:
if not repo_name:
repo_name = InputValidator.get_input(f"{Colors.BRIGHT_CYAN}>> 请输入Gitea仓库名: {Colors.ENDC}")
remote_url = f"ssh://git@{Config.GITEA_HOST}:{Config.GITEA_PORT}/{user}/{repo_name}.git"
gitea_host = Config.get_gitea_host()
gitea_port = Config.get_gitea_port()
remote_url = f"ssh://git@{gitea_host}:{gitea_port}/{user}/{repo_name}.git"
return self._add_remote("gitea", remote_url)
def add_custom_remote(self) -> bool:
"""
添加自建Git远程仓库
Returns:
是否成功
"""
from .utils import Colors
print(f"\n{Colors.BRIGHT_MAGENTA}>> 添加自建Git仓库{Colors.ENDC}")
print(f"{Colors.CYAN}{'-' * 60}{Colors.ENDC}")
OutputFormatter.tip("支持 GitLab、自建Gitea、Gogs 等 Git 服务器")
OutputFormatter.tip("SSH URL 格式示例:")
print(f"{Colors.WHITE} - git@gitlab.com:user/repo.git")
print(f"{Colors.WHITE} - ssh://git@your-server.com:port/user/repo.git{Colors.ENDC}")
print(f"{Colors.CYAN}{'-' * 60}{Colors.ENDC}")
# 输入远程仓库名称
remote_name = InputValidator.get_input(
f"{Colors.BRIGHT_CYAN}>> 请输入远程仓库名称 (如: gitlab, mygit): {Colors.ENDC}"
)
# 检查是否已存在
remotes = self.get_remotes()
if remote_name in remotes:
OutputFormatter.warning(f"远程仓库 '{remote_name}' 已存在")
if not InputValidator.confirm("是否覆盖?", default=False):
return False
self.executor.run(f"git remote remove {remote_name}", show_output=False)
# 输入SSH URL
remote_url = InputValidator.get_input(
f"{Colors.BRIGHT_CYAN}>> 请输入完整的SSH URL: {Colors.ENDC}"
)
# 验证URL格式
if not (remote_url.startswith("git@") or remote_url.startswith("ssh://")):
OutputFormatter.error("无效的SSH URL格式必须以 'git@''ssh://' 开头")
return False
return self._add_remote(remote_name, remote_url)
def configure_gitea_settings(self):
"""配置Gitea服务器设置"""
from .utils import Colors
print(f"\n{Colors.BRIGHT_MAGENTA}>> 配置Gitea服务器{Colors.ENDC}")
print(f"{Colors.CYAN}{'-' * 60}{Colors.ENDC}")
# 显示当前配置
current_host = Config.get_gitea_host()
current_port = Config.get_gitea_port()
OutputFormatter.info(f"当前配置:")
print(f"{Colors.WHITE} 主机: {current_host}{Colors.ENDC}")
print(f"{Colors.WHITE} 端口: {current_port}{Colors.ENDC}")
print(f"{Colors.CYAN}{'-' * 60}{Colors.ENDC}")
# 询问是否修改
if not InputValidator.confirm("是否修改Gitea服务器配置", default=False):
return
# 输入新的主机地址
new_host = InputValidator.get_input(
f"{Colors.BRIGHT_CYAN}>> 请输入Gitea主机地址 (回车保持 {current_host}): {Colors.ENDC}",
allow_empty=True
)
if new_host:
Config.set("gitea_host", new_host)
OutputFormatter.success(f"Gitea主机地址已更新为: {new_host}")
# 输入新的端口
new_port = InputValidator.get_input(
f"{Colors.BRIGHT_CYAN}>> 请输入SSH端口 (回车保持 {current_port}): {Colors.ENDC}",
allow_empty=True
)
if new_port:
Config.set("gitea_port", new_port)
OutputFormatter.success(f"Gitea SSH端口已更新为: {new_port}")
print(f"{Colors.CYAN}{'-' * 60}{Colors.ENDC}")
OutputFormatter.tip("配置已保存下次添加Gitea仓库时将使用新配置")
def _add_remote(self, name: str, url: str) -> bool:
"""
添加远程仓库
@@ -150,7 +238,7 @@ class RemoteManager:
OutputFormatter.menu_item(1, "GitHub")
OutputFormatter.menu_item(2, "Gitea")
OutputFormatter.menu_item(3, "两者都配置")
OutputFormatter.menu_item(3, "自建Git仓库")
OutputFormatter.menu_item(4, "跳过")
print(f"{Colors.CYAN}{'-' * 60}{Colors.ENDC}")
@@ -164,8 +252,7 @@ class RemoteManager:
elif choice == 2:
self.add_gitea_remote()
elif choice == 3:
self.add_github_remote()
self.add_gitea_remote()
self.add_custom_remote()
else:
OutputFormatter.info("跳过远程仓库配置")

View File

@@ -90,11 +90,12 @@ class GitManagerUI:
print(f"{Colors.CYAN}{'-' * 60}{Colors.ENDC}")
OutputFormatter.menu_item(1, "初始化Git仓库")
OutputFormatter.menu_item(2, "提交并推送更改")
OutputFormatter.menu_item(3, "远程仓库拉取")
OutputFormatter.menu_item(4, "查看仓库状态")
OutputFormatter.menu_item(5, "管理远程仓库")
OutputFormatter.menu_item(6, "退出程序")
OutputFormatter.menu_item(2, "提交更改到本地")
OutputFormatter.menu_item(3, "推送到远程仓库")
OutputFormatter.menu_item(4, "从远程仓库拉取")
OutputFormatter.menu_item(5, "查看仓库状态")
OutputFormatter.menu_item(6, "管理远程仓库")
OutputFormatter.menu_item(7, "退出程序")
print(f"{Colors.CYAN}{'-' * 60}{Colors.ENDC}")
# 显示永久提示
@@ -110,9 +111,9 @@ class GitManagerUI:
# 配置远程仓库
self.remote_mgr.configure_remotes_interactive()
def handle_commit_and_push(self):
"""处理提交并推送"""
OutputFormatter.header("提交并推送更改")
def handle_commit(self):
"""处理提交到本地"""
OutputFormatter.header("提交更改到本地")
if not self.git_ops.is_git_repo():
OutputFormatter.error("当前目录不是Git仓库请先初始化")
@@ -144,9 +145,26 @@ class GitManagerUI:
if not self.git_ops.commit(commit_msg or ""):
return
OutputFormatter.tip("提交成功如需推送到远程仓库请选择菜单选项3")
def handle_push(self):
"""处理推送到远程"""
OutputFormatter.header("推送到远程仓库")
if not self.git_ops.is_git_repo():
OutputFormatter.error("当前目录不是Git仓库请先初始化")
return
# 检查是否有提交可推送
OutputFormatter.status('running', "检查待推送的提交...")
# 推送到远程仓库
selected_remotes = self.remote_mgr.select_remote_for_push()
if not selected_remotes:
OutputFormatter.warning("未选择远程仓库")
return
for remote in selected_remotes:
self.git_ops.push(remote)
@@ -190,13 +208,15 @@ class GitManagerUI:
OutputFormatter.menu_item(1, "查看远程仓库")
OutputFormatter.menu_item(2, "添加GitHub远程仓库")
OutputFormatter.menu_item(3, "添加Gitea远程仓库")
OutputFormatter.menu_item(4, "删除远程仓库")
OutputFormatter.menu_item(5, "返回主菜单")
OutputFormatter.menu_item(4, "添加自建Git仓库")
OutputFormatter.menu_item(5, "配置Gitea服务器")
OutputFormatter.menu_item(6, "删除远程仓库")
OutputFormatter.menu_item(7, "返回主菜单")
print(f"{Colors.CYAN}{'-' * 60}{Colors.ENDC}")
choice = InputValidator.get_choice(
f"{Colors.BRIGHT_CYAN}>> 请选择 [1-5]: {Colors.ENDC}",
range(1, 6)
f"{Colors.BRIGHT_CYAN}>> 请选择 [1-7]: {Colors.ENDC}",
range(1, 8)
)
if choice == 1:
@@ -206,8 +226,12 @@ class GitManagerUI:
elif choice == 3:
self.remote_mgr.add_gitea_remote()
elif choice == 4:
self.remote_mgr.remove_remote()
self.remote_mgr.add_custom_remote()
elif choice == 5:
self.remote_mgr.configure_gitea_settings()
elif choice == 6:
self.remote_mgr.remove_remote()
elif choice == 7:
break
def run(self):
@@ -223,21 +247,23 @@ class GitManagerUI:
self.show_main_menu()
choice = InputValidator.get_choice(
f"{Colors.BRIGHT_MAGENTA}>> 请输入选项 [1-6]: {Colors.ENDC}",
range(1, 7)
f"{Colors.BRIGHT_MAGENTA}>> 请输入选项 [1-7]: {Colors.ENDC}",
range(1, 8)
)
if choice == 1:
self.handle_init_repo()
elif choice == 2:
self.handle_commit_and_push()
self.handle_commit()
elif choice == 3:
self.handle_pull()
self.handle_push()
elif choice == 4:
self.handle_show_status()
self.handle_pull()
elif choice == 5:
self.handle_manage_remotes()
self.handle_show_status()
elif choice == 6:
self.handle_manage_remotes()
elif choice == 7:
print(f"\n{Colors.BRIGHT_GREEN}{'=' * 60}")
print(f"{Colors.BRIGHT_GREEN}{Colors.BOLD} 感谢使用QuickGit祝您工作愉快{Colors.ENDC}")
print(f"{Colors.BRIGHT_GREEN}{'=' * 60}{Colors.ENDC}\n")

View File

@@ -1,5 +1,25 @@
# 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. 添加文件失败问题
@@ -54,22 +74,59 @@ Git状态: [已初始化]
>> 主菜单
------------------------------------------------------------
[1] 初始化Git仓库
[2] 提交并推送更改
[3] 远程仓库拉取
[4] 查看仓库状态
[5] 管理远程仓库
[6] 退出程序
[2] 提交更改到本地
[3] 推送到远程仓库
[4] 从远程仓库拉取
[5] 查看仓库状态
[6] 管理远程仓库
[7] 退出程序
------------------------------------------------------------
>> 请输入选项 [1-6]:
[*] 提交代码前建议先拉取最新代码,减少代码冲突
[*] 使用SSH进行Git提交更方便快捷和安全
------------------------------------------------------------
>> 请输入选项 [1-7]:
```
## 功能说明
所有功能均正常工作:
- ✓ 初始化Git仓库
- ✓ 提交并推送更改
- ✓ 从远程仓库拉取
- ✓ 提交更改到本地(不推送)
- ✓ 推送到远程仓库(通过 SSH
- ✓ 从远程仓库拉取(通过 SSH
- ✓ 查看仓库状态
- ✓ 管理远程仓库GitHub/Gitea
- ✓ 管理远程仓库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 用户名
- 默认分支名
界面美观、对齐完美、功能稳定!

View File

@@ -80,7 +80,7 @@
ssh -T git@github.com
# Gitea
ssh -T git@repo.shumengya.top -p 8022
ssh -T git@git.shumengya.top -p 8022
```
---