docs: 优化README文档,新增详细安装指南

- README: 重写为简洁风格,聚焦项目价值、快速启动、未来发展
- INSTALL.md: 新增完整安装指南,包含多种安装方式、配置说明、故障排除
- 改进AI友好度,提供一键安装/升级指令
- 符合用户使用习惯,提升文档可读性
This commit is contained in:
2026-07-17 21:57:54 +08:00
parent be4aa4d189
commit c06c94f0e5
2 changed files with 409 additions and 29 deletions
+40 -29
View File
@@ -1,51 +1,62 @@
# SAP-CLI-SKILL
sap-cli 的 AI Agent 可分发技能包。封装 SAP ADT REST API,让 AI 助手(Hermes / Claude Code)在终端完成 ABAP 开发对象的完整生命周期管理。
## 🎯 项目价值
## 与 sap-cli 的关系
SAP-CLI-SKILL 是一个让 AI 助手直接操作 SAP ABAP 系统的工具包。
| | sap-cli | SAP-CLI-SKILL |
|---|---|---|
| 定位 | 源码开发仓库 | AI Agent 分发包 |
| 地址 | [gitee.com/markwury168/sap-cli](https://gitee.com/markwury168/sap-cli) | 本仓库 |
| 内容 | 完整源码 + 测试 + OpenSpec | 构建产物 + SKILL.md + 安装脚本 |
**核心价值**
- **AI 驱动的 SAP 开发**:AI 助手可以读取、分析、修改 ABAP 代码
- **代码质量自动化**:自动化审计 ABAP 代码,发现潜在问题
- **开发效率提升**:AI 帮助完成重复性开发任务
- **持续集成支持**:集成到 CI/CD 流程,实现代码质量门禁
源码在 `sap-cli` 修改后,通过 `python scripts/pack_skill.py` 自动构建到本仓库。
**适用场景**
- SAP ABAP 代码审计和质量检查
- 批量对象处理和转换
- AI 辅助开发和重构
- 自动化测试和代码审查
## 安装
---
### Hermes Agent
## 🚀 快速启动
### 一键安装
```bash
git clone https://gitee.com/markwury168/sap-cli-skill.git ~/AppData/Local/hermes/skills/productivity/sap-cli
python ~/AppData/Local/hermes/skills/productivity/sap-cli/scripts/setup.py all
请帮我安装 sap-cli-skill: https://gitee.com/markwury168/sap-cli-skill/blob/master/INSTALL.md
```
复制给你的 Agent,几分钟后它就安装好了。
### Claude Code
### 验证安装
```bash
git clone https://gitee.com/markwury168/sap-cli-skill.git ~/.claude/skills/sap-cli
python ~/.claude/skills/sap-cli/scripts/setup.py all
cd ~/AppData/Local/hermes/skills/productivity/sap-cli/assets
python main.py --help
python main.py config show
```
验证:
### 快速使用
```bash
cd <SKILL_DIR>/assets && python main.py --help
# 获取对象信息
python main.py info --name ZMY_CLASS --type class
# 下载源码
python main.py download --name ZMY_PROGRAM --type prog --output /tmp/
# 列出对象
python main.py list --prefix Z --type prog
```
## 目录结构
---
```
SAP-CLI-SKILL/
├── SKILL.md # AI Agent 入口(命令速查、工作流、使用约束)
├── VERSION # 当前版本号
├── assets/ # sap-cli 可执行文件(源码包 + main.py + 配置模板)
├── references/ # 详细规则(ADT 约束、错误处理)
└── scripts/
└── setup.py # 一键安装(依赖 + pip install + 配置)
```
## 📚 详细文档
## License
- **[INSTALL.md](INSTALL.md)** - 完整安装指南
- **[SKILL.md](SKILL.md)** - AI Agent 使用指南
- **[references/](references/)** - 技术文档
MIT
---
**当前版本**: 2.2.1
**维护者**: SwiftCode Creative Technology