SuperAPI AI 工具集

sherpy-cli

通用与其它

查看项目

更新于 10-16 02:29

技能介绍

Sherpy CLI 用于校验 Sherpy YAML 文档是否符合 schema,并把有效文档转换为格式化 Markdown,适合在规划工作流和实现流程前检查文档结构。

主要能力:支持 business-requirements、technical-requirements、milestones、milestone-tasks、timeline、qa-test-plan、gap-analysis 等文档类型;校验包括必填字段与类型、字段长度、枚举值、日期格式、顺序 ID、引用有效性、依赖解析、循环依赖、里程碑数量、任务时长、回溯日期、QA 覆盖率、分配比例等。输出支持默认、strict(警告升级为错误)和 verbose 模式。安全方面包含路径穿越防护、10MB 文件大小限制、输出文件 0600 权限、Markdown 转义与 ReDoS 防护。

使用方式:

sherpy validate -t business-requirements -f docs/business-requirements.yaml sherpy validate -t business-requirements -f docs/business-requirements.yaml --strict sherpy to-markdown -t business-requirements -f docs/business-requirements.yaml sherpy to-markdown -t business-requirements -f docs/business-requirements.yaml -o output.md sherpy types sherpy prompt --list sherpy prompt -t business-requirements-interview

安装:go install github.com/validkeys/sherpy@latest,或从源码 git clone https://github.com/validkeys/sherpy.git 后 make build、sudo make install。退出码:0 成功,1 校验失败或命令错误,2 文件未找到或读取错误。

限制:文件需小于 10MB;禁止路径穿越;需使用受支持的文档类型名。收费、价格与平台信息暂未提供。