docs: add README

2026-06-13 22:39:42 +08:00
parent b43d3b11c3
commit 8e9f27b75d
1 changed files with 51 additions and 0 deletions
@@ -0,0 +1,51 @@
+# SAP-CLI-SKILL
+
+sap-cli 的 AI Agent 可分发技能包。封装 SAP ADT REST API，让 AI 助手（Hermes / Claude Code）在终端完成 ABAP 开发对象的完整生命周期管理。
+
+## 与 sap-cli 的关系
+
+| | sap-cli | SAP-CLI-SKILL |
+|---|---|---|
+| 定位 | 源码开发仓库 | AI Agent 分发包 |
+| 地址 | [gitee.com/markwury168/sap-cli](https://gitee.com/markwury168/sap-cli) | 本仓库 |
+| 内容 | 完整源码 + 测试 + OpenSpec | 构建产物 + SKILL.md + 安装脚本 |
+
+源码在 `sap-cli` 修改后，通过 `python scripts/pack_skill.py` 自动构建到本仓库。
+
+## 安装
+
+### 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
+```
+
+### 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
+```
+
+验证：
+
+```bash
+cd <SKILL_DIR>/assets && python main.py --help
+```
+
+## 目录结构
+
+```
+SAP-CLI-SKILL/
+├── SKILL.md              # AI Agent 入口（命令速查、工作流、使用约束）
+├── VERSION               # 当前版本号
+├── assets/               # sap-cli 可执行文件（源码包 + main.py + 配置模板）
+├── references/           # 详细规则（ADT 约束、错误处理）
+└── scripts/
+    └── setup.py          # 一键安装（依赖 + pip install + 配置）
+```
+
+## License
+
+MIT