Skip to content

Commit bd3d830

Browse files
authored
feat: add machine-readable help discovery (#46)
1 parent daea3b7 commit bd3d830

4 files changed

Lines changed: 1249 additions & 76 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,16 @@ raw Gitee API calls.
99

1010
The installed executable is named `gitee`.
1111

12+
For agent and LLM discovery, start with:
13+
14+
```bash
15+
gitee help --json
16+
```
17+
18+
This returns a machine-readable manifest of supported command groups,
19+
subcommands, flags, examples, and `gh`-style equivalents. To inspect one
20+
command only, use a topic path such as `gitee help pr create --json`.
21+
1222
> `gitee-cli` is an unofficial community project. It is not affiliated with,
1323
> endorsed by, or sponsored by Gitee or `gitee.com`.
1424
>

README_CN.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,16 @@ AI 驱动的工作流中操作 `gitee.com`。
1111

1212
安装后的可执行文件名为 `gitee`
1313

14+
如果是给 Agent 或大模型做能力发现,建议从下面这条命令开始:
15+
16+
```bash
17+
gitee help --json
18+
```
19+
20+
它会返回一份机器可读的能力清单,包含已支持的命令组、子命令、参数、示例
21+
以及与 `gh` 相近的命令映射。如果只想查看单个命令,可以使用
22+
`gitee help pr create --json` 这样的 topic path。
23+
1424
> `gitee-cli` 是一个非官方社区项目,与 Gitee 或 `gitee.com` 不存在关
1525
> 联关系,也未获得其认可、背书或赞助。
1626
>

0 commit comments

Comments
 (0)