yierp-skill/README.zh.md

YIERP CLI 技能说明

这是一个面向 YIERP（基于 ERPNext v16）的数据操作脚本包，适合通过配置 URL、apikey 和 ApiSecret 来执行常见的数据查询与写入操作。

目录说明

• SKILL.md：技能说明，适合作为 AI/脚本上下文。
• tools/yierp_cli.py：YIERP CLI 脚本。
• config.example.json：示例配置文件。
• requirements.txt：Python 依赖。

快速开始

1. 安装依赖：

   python -m pip install -r requirements.txt
   

2. 复制示例配置：

   copy config.example.json .yierp\config.json
   

3. 编辑 .yierp/config.json，填入真实参数：

   {
     "url": "https://yierp.example.com",
     "apikey": "你的_api_key",
     "ApiSecret": "你的_api_secret",
     "timeout": 30,
     "verify_ssl": true
   }
   

4. 运行命令：

   python tools/yierp_cli.py whoami --config .yierp/config.json
   python tools/yierp_cli.py list --config .yierp/config.json --doctype ToDo --limit 10
   python tools/yierp_cli.py create --config .yierp/config.json --doctype ToDo --data '{"description":"测试任务","status":"Open"}'
   

常用命令

# 连接检测
python tools/yierp_cli.py whoami

# 查询列表
python tools/yierp_cli.py list --doctype ToDo --filters '{"status":"Open"}' --limit 20

# 获取单条记录
python tools/yierp_cli.py get --doctype ToDo --name "TODO-00001"

# 创建记录
python tools/yierp_cli.py create --doctype ToDo --data '{"description":"新任务","status":"Open"}'

# 更新记录
python tools/yierp_cli.py update --doctype ToDo --name "TODO-00001" --data '{"status":"Closed"}'

# 删除记录
python tools/yierp_cli.py delete --doctype ToDo --name "TODO-00001" --yes

# 调用自定义方法
python tools/yierp_cli.py method --method "your_app.api.test" --args '{"message":"hello"}'

注意事项

• 对于删除、更新和批量修改类操作，请先确认 DocType、名称和修改内容。

• ApiSecret 是敏感信息，请勿提交到代码仓库或日志中。

• 生产环境建议使用环境变量覆盖配置：

  set YIERP_URL=https://yierp.example.com
  set YIERP_APIKEY=你的_api_key
  set YIERP_APISECRET=你的_api_secret
  

• 如果 YIERP 站点使用自签名证书或内网 HTTPS，请适当调整 verify_ssl。