# gitOneKeySetUp

**Repository Path**: Dinomorphia/git-one-key-set-up

## Basic Information

- **Project Name**: gitOneKeySetUp
- **Description**: 一键配置gitee
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-05
- **Last Updated**: 2026-08-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Gitee 一键安装配置工具

一个 Windows 桌面端 Gitee 一键安装配置工具，帮助无 Git 环境的用户快速完成 **Git 安装**、**TortoiseGit 安装** 和 **Gitee SSH 密钥配置**。

## 功能特点

- **环境检测**：自动检测 Git 和 TortoiseGit 是否已安装
- **一键静默安装**：通过 Windows 内置的 winget 包管理器静默安装 Git 和 TortoiseGit
- **自定义安装目录**：支持用户指定软件安装路径
- **Git 用户信息配置**：配置全局 `user.name` 和 `user.email`
- **HTTPS 地址自动转 SSH**：配置 Git 全局地址改写，克隆 HTTPS 地址时自动走 SSH
- **SSH 密钥生成**：使用 ED25519 算法生成安全的 SSH 密钥对
- **Gitee 连接测试**：自动添加 known_hosts 并测试 SSH 连接
- **现代化界面**：基于 CustomTkinter 的 Windows 11 风格界面

## 系统要求

- **操作系统**：Windows 10 1809+ / Windows 11
- **Python**：3.10+（如果从源码运行）
- **Winget**：Windows 10 1809+ 内置，如不可用请先安装 [App Installer](https://apps.microsoft.com/detail/9nblggh4nns1)

## 快速开始

### 方式一：运行打包好的 EXE（推荐）

直接双击 `GiteeOneKeySetup.exe` 即可运行，无需安装 Python。

### 方式二：从源码运行

```bash
# 1. 安装依赖
pip install -r requirements.txt

# 2. 运行程序
python src/main.py
```

### 方式三：自行打包

```bash
pip install -r requirements.txt
python build.py
# 输出文件: dist/GiteeOneKeySetup.exe
```

## 使用步骤

程序采用 **4 步向导** 引导完成整个配置流程：

### 第 1 步：环境检测
- 自动检测 winget、Git、TortoiseGit 是否已安装
- 绿色表示已安装，红色表示未安装

### 第 2 步：安装配置
- 选择软件安装目录（默认 `C:\Program Files\Git`）
- 可以单独安装 Git 或 TortoiseGit，也可以「一键安装全部」
- 实时显示安装进度和日志

### 第 3 步：用户信息
- 输入 Gitee 用户名和注册邮箱
- 勾选「将 HTTPS 克隆地址自动替换为 SSH」开关（默认开启）
- 点击「应用配置」保存到 Git 全局设置，同时配置地址改写规则

### 第 4 步：SSH 密钥
- 点击「生成 SSH 密钥对」创建 ED25519 密钥
- 复制公钥，点击「打开 Gitee SSH 设置页」跳转到 Gitee
- 在 Gitee 网页粘贴并保存公钥
- 点击「我已在 Gitee 添加公钥」
- 点击「测试 Gitee SSH 连接」验证配置

## Gitee SSH 配置说明

工具会自动完成以下操作：

1. `git config --global user.name` - 设置用户名
2. `git config --global user.email` - 设置邮箱
3. `git config --global url."git@gitee.com:".insteadOf "https://gitee.com/"` - HTTPS 克隆地址自动转 SSH
4. `ssh-keygen -t ed25519 -C "邮箱"` - 生成 SSH 密钥对
5. `ssh-keyscan gitee.com` - 添加 Gitee 到信任主机
6. 配置 `~/.ssh/config` - 添加 Gitee Host 配置
7. `ssh -T git@gitee.com` - 测试连接

密钥文件位置：
- 私钥：`~/.ssh/id_ed25519_gitee`
- 公钥：`~/.ssh/id_ed25519_gitee.pub`

## 项目结构

```
gitOneKeySetUp/
├── exeFiles/                  # TortoiseGit 备用安装包
├── src/                       # Python 源码
│   ├── main.py                # 程序入口
│   ├── ui/                    # UI 界面
│   │   ├── main_window.py     # 主窗口
│   │   ├── step_detect.py     # 环境检测页
│   │   ├── step_install.py    # 安装配置页
│   │   ├── step_git_config.py # 用户信息页
│   │   └── step_ssh_setup.py  # SSH 配置页
│   ├── core/                  # 核心逻辑
│   │   ├── checker.py         # 环境检测
│   │   ├── installer.py       # winget 安装
│   │   └── gitee_config.py    # Gitee 配置
│   └── utils/                 # 工具
│       └── logger.py          # 日志工具
├── build.py                   # 打包脚本
├── requirements.txt           # Python 依赖
└── README.md
```

## 常见问题

**Q: 提示 "winget 不可用"?**
A: 请确保系统为 Windows 10 1809+ 或 Windows 11。也可以从 Microsoft Store 安装 [App Installer](https://apps.microsoft.com/detail/9nblggh4nns1)。

**Q: Git 安装后仍提示未安装?**
A: 安装完成后可能需要重启终端或注销重新登录，以使 PATH 环境变量生效。可以先继续配置，配置完成后重启即可。

**Q: SSH 连接测试失败?**
A: 请检查：
1. 公钥是否完整复制到 Gitee 网页（不要有多余的换行或空格）
2. Gitee 页面上是否点击了「确定」保存
3. 网络是否可以正常访问 `gitee.com`

**Q: 密钥文件在哪里?**
A: 在用户目录下的 `.ssh` 文件夹中，文件名为 `id_ed25519_gitee`（私钥）和 `id_ed25519_gitee.pub`（公钥）。

## 技术栈

- **语言**：Python 3.10+
- **UI 框架**：CustomTkinter（现代化 tkinter 封装）
- **包管理**：winget（Windows Package Manager）
- **打包**：PyInstaller