@hust-open-atom-club/atomgit-cli 0.7.0 → 0.7.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +83 -40
  2. package/package.json +8 -8
package/README.md CHANGED
@@ -1,90 +1,127 @@
1
1
  # AtomGit CLI (ag)
2
2
 
3
+ [![License](https://img.shields.io/badge/license-MulanPSL--2.0-blue.svg)](LICENSE)
4
+ [![npm](https://img.shields.io/npm/v/%40hust-open-atom-club%2Fatomgit-cli?logo=npm)](https://www.npmjs.com/package/@hust-open-atom-club/atomgit-cli)
5
+ [![Latest Release](https://img.shields.io/github/v/release/hust-open-atom-club/atomgit-cli?display_name=tag)](https://atomgit.com/hust-open-atom-club/atomgit-cli/releases)
6
+ [![Build](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.atomgit.com%2Fapi%2Fv8%2Frepos%2Fhust-open-atom-club%2Fatomgit-cli%2Factions%2Fruns%3Fworkflow_name%3DCI%26branch%3Dmain%26per_page%3D1&query=%24.workflow_runs%5B0%5D.status&label=build)](https://atomgit.com/hust-open-atom-club/atomgit-cli/actions)
7
+ [![Homebrew](https://img.shields.io/badge/homebrew-tap-FBB040?logo=homebrew&logoColor=white)](https://github.com/hust-open-atom-club/homebrew-tap)
8
+ [![Go Reference](https://pkg.go.dev/badge/atomgit.com/hust-open-atom-club/atomgit-cli.svg)](https://pkg.go.dev/atomgit.com/hust-open-atom-club/atomgit-cli)
9
+ [![GoReleaser](https://img.shields.io/badge/powered_by-GoReleaser-69D7E4?logo=goreleaser&logoColor=white)](https://goreleaser.com/)
10
+
3
11
  AtomGit 命令行工具，参考 GitHub CLI (gh) 开发。
4
12
 
13
+ ## 功能
14
+
15
+ | 类别 | 能力 |
16
+ | --- | --- |
17
+ | 📦 仓库 | 列出、查看、创建、编辑、克隆、删除、复刻和同步仓库 |
18
+ | 👥 协作者 | 列出、查看、添加、修改和移除仓库协作者 |
19
+ | 🔔 Webhook | 列出、查看、创建、编辑、删除和测试仓库 Webhook |
20
+ | 🌿 分支 | 列出、查看、创建和删除分支，管理分支保护规则 |
21
+ | 🔀 Pull Request | 列出、查看、创建、编辑、关闭、重开、审查、合并和检出 PR，查看差异与检查结果，管理评论和关联 Issue |
22
+ | 🐛 Issue | 列出、查看、创建、编辑、关闭和重开 Issue，管理标签和评论 |
23
+ | 🔖 标签 | 列出、创建、编辑和删除仓库标签 |
24
+ | 🎯 里程碑 | 列出、查看、创建、编辑、关闭、重开和删除里程碑 |
25
+ | 🏷️ Tag | 列出、创建和删除 Git tag |
26
+ | 🚀 Release | 列出、查看、创建和编辑 Release，上传和下载附件 |
27
+ | ⚙️ Actions | 列出和查看 workflow 运行、job、日志与 artifact，并下载日志和 artifact |
28
+ | 🏢 组织 | 列出当前账号加入的组织 |
29
+ | 🔍 搜索 | 搜索仓库、用户和 Issue |
30
+ | 💬 Discussion | 列出仓库 Discussion |
31
+ | 🔔 通知 | 列出仓库通知并标记已读 |
32
+ | 🔐 认证与 SSH Key | OAuth 登录、刷新和切换账号，查看认证状态，管理 SSH 公钥 |
33
+ | 🌐 API | 调用 AtomGit API v5，支持分页、JSON 请求体和 GET、POST、PATCH、PUT、DELETE 方法 |
34
+
35
+ ## AI Agent Skills
36
+
37
+ [AtomGit Skills](https://atomgit.com/hust-open-atom-club/atomgit-skills) 提供由 `ag` 驱动的 Codex Skills，覆盖 Issue、Pull Request、CLI 发布和 GitHub 镜像工作流。安装方式和完整清单见该仓库。
38
+
5
39
  ## 安装
6
40
 
7
41
  ### npm
8
42
 
9
- 需要 Node.js 18 或更高版本：
10
-
11
43
  ```bash
12
- npm install --global @hust-open-atom-club/atomgit-cli
44
+ npm install -g @hust-open-atom-club/atomgit-cli
13
45
  ```
14
46
 
15
- npm 会通过当前操作系统和 CPU 对应的可选依赖安装预编译二进制，不需要运行 `postinstall` 脚本。
16
-
17
47
  ### Homebrew
18
48
 
19
- macOS 或 Linux 用户可以通过项目维护的 Homebrew tap 安装：
20
-
21
49
  ```bash
22
50
  brew install hust-open-atom-club/tap/atomgit-cli
23
51
  ```
24
52
 
25
- ### Scoop
26
-
27
- Windows 用户可以通过组织维护的 scoop bucket 安装：
53
+ ### WinGet
28
54
 
29
55
  ```powershell
30
- scoop install https://raw.githubusercontent.com/hust-open-atom-club/ScoopBucket/main/bucket/atomgit-cli.json
56
+ winget install HUSTOpenAtomClub.AtomGitCLI
31
57
  ```
32
58
 
33
- Scoop 安装的二进制由 Scoop 管理升级，并报告 `selfUpdate=false, source=scoop`。
59
+ ### Scoop
34
60
 
35
- ### Nix / NixOS
61
+ ```powershell
62
+ scoop bucket add hust-open-atom-club https://github.com/hust-open-atom-club/ScoopBucket
63
+ scoop install atomgit-cli
64
+ ```
36
65
 
37
- AtomGit CLI 已进入 `nixos-unstable`，包名为 `atomgit-cli`，安装后提供 `ag` 命令。
66
+ ### Nix / NixOS
38
67
 
39
- 如果你的 Nix registry 或 flake input 已指向 `nixos-unstable`：
68
+ 目前仅 `nixos-unstable` 提供 `atomgit-cli`，请确保 `nixpkgs` 指向 unstable；stable 尚未收录。
40
69
 
41
70
  ```bash
42
71
  nix profile install nixpkgs#atomgit-cli
43
72
  ```
44
73
 
45
- 如果你使用的是稳定版 nixpkgs，可以显式从 `nixos-unstable` 安装：
46
-
47
- ```bash
48
- nix profile install github:NixOS/nixpkgs/nixos-unstable#atomgit-cli
49
- ```
50
-
51
74
  ### Go
52
75
 
53
- 需要 Go 1.24.2 或更高版本。项目正式支持 macOS、Linux 和 Windows；其他 Go 目标平台的兼容性不作保证：
54
-
55
76
  ```bash
56
77
  go install atomgit.com/hust-open-atom-club/atomgit-cli/cmd/ag@latest
57
78
  ```
58
79
 
59
- **注意：** 通过 Go 模块代理安装时，`ag version` 能显示模块版本，但由于模块代理提供的源码包不包含 Git 历史，文本输出会省略无法获得的 commit 和构建时间；`ag version --json` 中对应字段为 `unknown`。这不影响 CLI 功能；如需完整的版本元数据，请使用 npm、Homebrew 或 Release 页面提供的预编译版本。
60
-
61
- 其他安装方式请参阅[完整安装指南](docs/installation.md)。
80
+ 安装要求、升级方式、AtomGit Release 和源码安装请参阅[完整安装指南](docs/installation.md)。
62
81
 
63
82
  ## 配置
64
83
 
65
- 首次使用时运行 `ag auth login` 完成 OAuth 登录。访问令牌、手动配置、输出安全和仓库推断规则请参阅[配置指南](docs/configuration.md)。
84
+ 首次使用时运行 `ag auth login` 完成 OAuth 登录；无浏览器环境（沙箱、容器、CI）可改用 `echo "$TOKEN" | ag auth login --with-token` 通过已有访问令牌登录。凭据、输出安全和仓库推断参阅[配置指南](docs/configuration.md)。
66
85
 
67
- ## 命令
68
-
69
- 完成认证后，可以通过 `ag` 管理 AtomGit 仓库、Issue、Pull Request、Release 和其他资源：
86
+ ## 常用命令
70
87
 
71
88
  ```bash
72
- ag auth status
73
89
  ag repo view
74
- ag issue list
90
+ ag repo read-file owner/repo README.md
91
+ ag repo read-dir owner/repo .
92
+ ag repo collaborator list
93
+ ag repo webhook list
94
+ ag branch list owner/repo
75
95
  ag pr list
96
+ ag pr commits owner/repo 42
97
+ ag pr files owner/repo 42
98
+ ag issue list
99
+ ag issue create owner/repo --title "Bug report" --assignee alice
100
+ ag issue prs owner/repo 42
101
+ ag issue branches owner/repo 42 --add feature/fix
102
+ ag label list
103
+ ag milestone list
104
+ ag tag list
105
+ ag release list
106
+ ag run list owner/repo
107
+ ag discussion list
108
+ ag notification list
109
+ ag org list
110
+ ag search repositories atomgit
111
+ ag auth status
112
+ ag ssh-key list
113
+ ag api /user
114
+ ag check-update
76
115
  ag --help
77
116
  ```
78
117
 
79
- 各命令的参数、行为说明和完整示例请参阅[命令使用指南](docs/usage.md)。
80
-
81
- ## 发布打包
118
+ 完整命令参阅[使用指南](docs/usage.md)。
119
+ 安装、认证、使用和故障排查中的常见问题请参阅[常见问题（FAQ）](docs/faq.md)。
82
120
 
83
- GoReleaser、npm 制品和 Nix package 的发布与维护流程请参阅[发布指南](docs/releasing.md)。
121
+ ## 更多文档
84
122
 
85
- ## 项目结构
86
-
87
- CLI 的主要执行流程为 `cmd/ag` → `internal/agcmd` → `pkg/cmd/root` → 各命令包。目录职责、命令包列表和扩展方式请参阅[项目结构说明](docs/project-structure.md)。
123
+ - [发布指南](docs/releasing.md)
124
+ - [项目结构](docs/project-structure.md)
88
125
 
89
126
  ## API
90
127
 
@@ -92,7 +129,7 @@ CLI 的主要执行流程为 `cmd/ag` → `internal/agcmd` → `pkg/cmd/root`
92
129
 
93
130
  Actions 运行检查使用独立的 AtomGit API v8：`https://api.atomgit.com/api/v8`。
94
131
 
95
- ## 参考
132
+ ### 参考
96
133
 
97
134
  - [AtomGit API 文档](https://docs.atomgit.com/docs/apis/)
98
135
  - [GitHub CLI](https://cli.github.com/)
@@ -102,3 +139,9 @@ Actions 运行检查使用独立的 AtomGit API v8：`https://api.atomgit.com/ap
102
139
  [木兰宽松许可证第2版](LICENSE) (Mulan Permissive Software License, Version 2)
103
140
 
104
141
  Copyright (c) 2026 HUST OpenAtom Club, AtomGit, and the AtomGit CLI contributors
142
+
143
+ ## Contributors
144
+
145
+ <a href="https://github.com/hust-open-atom-club/atomgit-cli/graphs/contributors">
146
+ <img src="https://contrib.rocks/image?repo=hust-open-atom-club/atomgit-cli" alt="AtomGit CLI contributors" />
147
+ </a>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hust-open-atom-club/atomgit-cli",
3
- "version": "0.7.0",
3
+ "version": "0.7.2",
4
4
  "description": "AtomGit command-line interface",
5
5
  "license": "MulanPSL-2.0",
6
6
  "repository": {
@@ -28,13 +28,13 @@
28
28
  "version:npm": "node scripts/set-npm-version.js"
29
29
  },
30
30
  "optionalDependencies": {
31
- "@hust-open-atom-club/atomgit-cli-darwin-arm64": "0.7.0",
32
- "@hust-open-atom-club/atomgit-cli-darwin-x64": "0.7.0",
33
- "@hust-open-atom-club/atomgit-cli-linux-arm64": "0.7.0",
34
- "@hust-open-atom-club/atomgit-cli-linux-loong64": "0.7.0",
35
- "@hust-open-atom-club/atomgit-cli-linux-x64": "0.7.0",
36
- "@hust-open-atom-club/atomgit-cli-win32-arm64": "0.7.0",
37
- "@hust-open-atom-club/atomgit-cli-win32-x64": "0.7.0"
31
+ "@hust-open-atom-club/atomgit-cli-darwin-arm64": "0.7.2",
32
+ "@hust-open-atom-club/atomgit-cli-darwin-x64": "0.7.2",
33
+ "@hust-open-atom-club/atomgit-cli-linux-arm64": "0.7.2",
34
+ "@hust-open-atom-club/atomgit-cli-linux-loong64": "0.7.2",
35
+ "@hust-open-atom-club/atomgit-cli-linux-x64": "0.7.2",
36
+ "@hust-open-atom-club/atomgit-cli-win32-arm64": "0.7.2",
37
+ "@hust-open-atom-club/atomgit-cli-win32-x64": "0.7.2"
38
38
  },
39
39
  "devDependencies": {
40
40
  "adm-zip": "^0.6.0",