# ge

**Repository Path**: imjoey/ge

## Basic Information

- **Project Name**: ge
- **Description**: ge（gitee-cli）是一个 AI-Native 、基于 Go 编写的 Gitee 命令行工具，对标 GitHub CLI (gh)
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 13
- **Forks**: 2
- **Created**: 2026-05-12
- **Last Updated**: 2026-06-29

## Categories & Tags

**Categories**: vcs

**Tags**: None

## README

<div align="center">

# ge · Gitee CLI

**Gitee on the command line.**

[![Go Reference](https://pkg.go.dev/badge/gitee.com/imjoey/ge/v5.svg)](https://pkg.go.dev/badge/gitee.com/imjoey/ge/v5)
[![Go Report Card](https://goreportcard.com/badge/gitee.com/imjoey/ge/v5)](https://goreportcard.com/report/gitee.com/imjoey/ge/v5)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

</div>

GitHub 有 [`gh`](https://github.com/cli/cli)，GitLab 有 [`glab`](https://gitlab.com/gitlab-org/cli)，**Gitee 一直没有官方 CLI —— `ge` 填补了这个空白。**

`ge` 把仓库、Issue、Pull Request、Release 等 Gitee 操作带到你的终端，让你在 `git` 旁边就能完成一切。更特别的是：**它从第一天起就是为 AI Agent 设计的** —— 使用说明（SKILL.md + references）内嵌进二进制，Agent 装上即用，无需翻文档。

```bash
$ ge repo create --name my-project --private
$ ge issue create --repo my-project --title "Fix login bug"
$ ge pr list --repo my-project
$ ge release create v1.0.0 --repo my-project
```

---

## 给 AI Agent：一键安装

把下面这段**原样**发给你的 AI Agent（Claude Code / Codex / Hermes / OpenClaw / OpenCode / Gemini 等），它会自动完成安装、认证、并把 skills 同步到本机所有 agent 平台：

```
请帮我安装 ge（Gitee CLI）。

ge 是 Gitee 平台的命令行工具，它的使用说明（SKILL.md + references）内嵌在
二进制里。安装脚本会自动调用 `ge setup` 把最新 skills 同步到本机所有已安装
的 AI agent 平台，`ge doctor` 用于校验各平台 skills 版本是否与二进制一致。

请按顺序执行：

1. 一键安装（可信源 gitee.com/imjoey/ge，默认装到 ~/.local/bin，无需 root）：
   curl -sL https://gitee.com/imjoey/ge/raw/main/scripts/install.sh | bash

2. 配置认证（在 https://gitee.com/profile/personal_access_tokens 生成 token）：
   export GITEE_TOKEN=<your-personal-access-token>

3. 校验安装：
   ge --version
   ge doctor

完成后请告诉我：ge 版本号、ge doctor 检测到哪些 agent 平台、是否全部 up to date。
如果任何一步失败，把报错原文贴出来，不要自行猜测原因。
```

## 给 AI Agent：一键升级

已装过 ge？把这段发给 agent，它会把 ge 和所有 agent 平台的 skills 一起升到最新：

```
请帮我升级本机的 gitee-cli (ge) 及其 skills。

ge 的使用说明内嵌在二进制里，升级 ge 后运行 `ge setup` 会自动把最新 skills
同步到本机所有已安装的 AI agent 平台，`ge doctor` 校验各平台版本是否对齐。

请按顺序执行：

1. 升级（可信源 gitee.com/imjoey/ge）：
   curl -sL https://gitee.com/imjoey/ge/raw/main/scripts/install.sh | bash

2. 确认版本：
   ge --version

3. 校验 skills 对齐：
   ge doctor

完成后请告诉我：升级后的 ge 版本号、ge doctor 检测到哪些 agent 平台、是否
全部 up to date。如果任何一步失败，把报错原文贴出来，不要自行猜测原因。
```

> ** Skills 同步机制**：`ge setup` 自动探测已装的 agent 平台（ZCode / Claude Code / Hermes / OpenClaw / OpenCode / Gemini 等全局级，Codex / Roo / Cursor / Copilot 等项目级），把内嵌 skills 写到各自目录。无需为每个 agent 单独操作 —— 一次 `ge setup` 全部搞定。详见 [setup/doctor 参考](skills/gitee-cli/references/commands/setup-doctor.md)。

---

## 人类快速开始

### 1. 安装

```bash
curl -sL https://gitee.com/imjoey/ge/raw/main/scripts/install.sh | bash
```

默认装到 `~/.local/bin/ge`（无需 root）。自定义目录：`bash -s -- --install-dir ~/bin`。

### 2. 认证

在 [Gitee → 私人令牌](https://gitee.com/profile/personal_access_tokens) 生成 Token，然后：

```bash
export GITEE_TOKEN=your_personal_access_token   # 或 ge auth login --token <token>
ge auth status
```

### 3. 试试看

```bash
ge user info                  # 你的信息
ge repo list                  # 你的仓库
ge repo create --name hello-world --private
ge search repos "golang cli"
```

每个命令都支持 `--help`。

---

## 为什么是 ge？

- 🤖 **Agent 优先（ai-native）** — skills 通过 `go:embed` 内嵌进二进制，binary 与 skills 永远同版本发布。`ge setup` 一键同步到所有 agent 平台，`ge doctor` 自检对齐。告别「binary 升级了 skill 还停留在旧版」的漂移。
- 🌐 **完整 API v5 覆盖** — 覆盖 Gitee API v5 全部端点，仓库 / Issue / PR / Release / 分支 / 用户 / 通知 / 搜索 / 企业版 / Webhook 等。
- 🚀 **开箱即用** — 单二进制，零依赖，macOS / Linux / Windows 全平台。
- 🔌 **非交互友好** — 所有命令支持 `--yes` / 环境变量，适合 CI/CD 和 Agent 调用。
- 🏗️ **架构对标 gh** — Factory 模式、IOStreams、httpmock，代码质量经得起考验。

## 命令一览

| 领域 | 命令 | 做什么 |
|------|------|--------|
| 仓库 | `ge repo` | 创建/删除/fork/文件读写/协作者 |
| Issue | `ge issue` | 完整生命周期 + 评论 + 标签 |
| Pull Request | `ge pr` | 创建/审核/测试/合并（Gitee 三步审批） |
| Release | `ge release` | 创建/查看/删除 + 附件 |
| 分支/标签 | `ge branch` `ge tag` | 列表/创建/保护 |
| 用户/组织 | `ge user` `ge org` | 信息/SSH key/成员 |
| 通知 | `ge notification` | 站内通知 + 私信 |
| 搜索 | `ge search` | 仓库/Issue/用户 |
| Skills | `ge setup` `ge doctor` | 同步/校验 agent skills |

完整 flag 表与示例见 [命令参考](skills/gitee-cli/references/commands/)，端到端工作流见 [任务流程](skills/gitee-cli/references/workflows/)。

## 配置

**Token 优先级**：`GITEE_TOKEN` 环境变量 > `GE_TOKEN` > 配置文件 `~/.config/ge/config.yml`。

<details>
<summary>配置文件示例</summary>

```yaml
gitee_token: your_token   # 不推荐，优先用环境变量
owner: your_username      # 默认 owner
git_protocol: https
editor: vim
```

环境变量：`GITEE_TOKEN`、`GE_TOKEN`、`GE_CONFIG_PATH`（自定义配置路径）。

</details>

---

## 开发

```bash
make build      # 构建
make test       # 测试（2331+ 用例）
make lint       # golangci-lint
```

架构设计（对标 gh）、贡献指南、ge 与 gh 的差异等见：

- [贡献指南](CONTRIBUTING.md)
- [ge 与 gh 差异](docs/ge-vs-gh.md)
- [Agent Skill 入口](skills/gitee-cli/SKILL.md) — 所有 agent 框架通用的 ge 操作指南
- [Gitee API v5 文档](https://gitee.com/api/v5/swagger)

## 许可证

[MIT License](LICENSE)

---

<div align="center">

**如果 ge 对你有帮助，请给个 ⭐ Star 支持一下！**

</div>