🤖 AI Agent 入口

Agent 可读取以下结构化文档，自动理解工具协议、输出格式和调用方式：

📋 AGENT-INDEX.json

机器可读文档索引
包含工具参数、退出码、环境变量、文档结构

📐 SCHEMA.json

JSON Schema 定义
用于验证审计报告输出格式

📖 AGENT-PROTOCOL.md

Agent 操作协议
调用方式、输出解析、决策树、错误处理

# Agent 一键获取文档索引
curl -s https://ninjasln-labs.github.io/repo-audit/AGENT-INDEX.json | jq '.tool.invocation'

# 验证审计报告
jq --argfile schema https://ninjasln-labs.github.io/repo-audit/SCHEMA.json \
  'empty as $_ | ., (input)' audit-report.json > /dev/null

📖 人类使用手册

安装、快速开始、参数说明、环境变量、审计维度、故障排查、与 scaffold 配合

→ HUMAN-GUIDE.md

🤖 Agent 操作手册

调用协议、输出解析、标准操作流程、错误处理、决策树、授权路径

→ AGENT-GUIDE.md

🔍 审计方法论

评分体系、规则设计、维度划分、分类检测逻辑

→ AUDIT.md

📏 最佳实践

工程仓库应满足的标准化检查项，按维度分类

→ BEST-PRACTICES.md

🏷️ 分类检测

19 种仓库类型识别逻辑，置信度评分，自动检测规则

→ REPO-CLASSIFICATION.md

🚀 脚手架生成

从零生成符合规范的工程脚手架，支持 6 种分类

→ templates/README.md

⚡ 快速开始

# 全局安装
npm install -g repo-audit-tool

# 审计仓库
repo-audit --repo /path/to/repo

# JSON 输出
repo-audit --repo /path/to/repo --format json

# 生成脚手架（从仓库源码运行时）
git clone https://github.com/NinjaSln-labs/repo-audit && cd repo-audit
node templates/scaffold.mjs --type dsh-plugin --name my-plugin

💬 反馈通道

工具内置 --feedback 命令，一键创建 GitHub Issue（自动预填上下文）。也可通过以下方式反馈：

# 工具内反馈（自动预填审计结果）
repo-audit --feedback "问题描述"

# GitHub Issues
https://github.com/NinjaSln-labs/repo-audit/issues

# Bug 报告（预填模板）
https://github.com/NinjaSln-labs/repo-audit/issues/new?template=bug_report.yml