gididaf/llm-sense
GitHub: gididaf/llm-sense
一款分析代码库对 LLM 友好程度的工具,通过静态分析和实证测试给出 0-100 评分,并生成可执行的改进任务。
Stars: 0 | Forks: 0
# llm-sense
分析您的代码库对 LLM 的友好程度。获取评分、详细发现以及 Claude Code(或任何 AI 编码助手)可直接执行的自包含改进任务。
## 为什么
当 LLM 处理您的代码时,其效率取决于代码库的结构。混乱的结构意味着浪费 token、上下文噪音增加、任务执行变慢。**llm-sense** 通过实证测量这些因素,并准确告诉您需要修复的内容。
## 安装
```
npx llm-sense --path ./your-project
```
或全局安装:
```
npm install -g llm-sense
```
## 功能说明
```
Phase 1: Static Analysis (free, ~300ms) → file sizes, structure, naming, docs, noise
Phase 2: LLM Understanding (1 Claude call) → architecture, tech stack, complexity
Phase 3: Task Generation (1 Claude call) → synthetic bugs + features
Phase 4: Empirical Testing (N Claude calls) → solve tasks in git worktrees, measure results
Phase 5: Scoring (instant) → weighted 0-100 score across 8 categories
Phase 6: Report Generation (instant) → detailed MD with LLM-executable improvement tasks
```
## 快速开始
**静态扫描(免费,即时):**
```
llm-sense --skip-empirical --path ./my-app
```
**完整扫描含实证测试(需要 Claude Code CLI):**
```
llm-sense --path ./my-app --bugs 3 --features 3
```
**查看评分历史:**
```
llm-sense --history --path ./my-app
```
## 输出结果
一份 Markdown 报告,包含:
- **总体评分**(0-100)及字母等级
- **8 个类别评分**:文档、文件大小、结构、模块化、上下文效率、命名、任务完成度、Token 效率
- **自包含改进任务** — 每个任务包含当前状态、期望最终状态、实施步骤和验收标准。复制任何任务并粘贴到 Claude Code 即可实施。
- **CLAUDE.md 草稿生成** — 如果您的项目缺少 CLAUDE.md,报告将包含基于 LLM 分析的完整草稿
- **评分历史追踪** — 重复运行以查看改进情况
## 评分类别
| 类别 | 衡量内容 | 权重 |
|---|---|---|
| 文档 | CLAUDE.md 质量(8 个部分)、README、注释、AI 工具配置 | 20% |
| 任务完成度 | Claude 能否真正解决您代码库中的问题?(实证) | 20% |
| 文件大小 | 中位数/P90 文件大小、神文件检测 | 15% |
| 结构 | 目录深度、每个目录的文件数 | 10% |
| 模块化 | 模块组织、桶式导出、单一文件目录 | 10% |
| 上下文效率 | 信噪比、生成的文件、二进制文件 | 10% |
| Token 效率 | 每个成功任务消耗的 token(实证) | 10% |
| 命名 | 文件命名规范一致性 | 5% |
## CLI 选项
```
llm-sense [options]
Options:
--path Target codebase (default: .)
--bugs Synthetic bug tasks (default: 5)
--features Synthetic feature tasks (default: 5)
--output Report file path (default: llm-sense-report.md)
--max-budget-per-task <$> Max USD per empirical task (default: 1.00)
--max-turns-per-task Max turns per task (default: 30)
--skip-empirical Skip Phases 2-4 (free, instant, static-only)
--model Override Claude model
--verbose Detailed progress output
--history Show score history
-V, --version Version
-h, --help Help
```
## 环境要求
- **Node.js 18+**
- **Claude Code CLI**(用于第 2-4 阶段)— 从 [claude.ai/code](https://claude.ai/code) 安装
- 静态分析(第 1 阶段)无需 Claude Code CLI 即可运行
## 报告说明
报告中的每个改进任务都设计为**可直接复制粘贴到 Claude Code** 或输入到 [Ralph](https://github.com/frankbria/ralph-claude-code) 进行自主执行。任务是自包含的 — 无需其他任务的上下文。
报告中的任务示例:
```
### 任务 1:添加 2 个缺失部分到 CLAUDE.md
**Priority 1** | **Category:** Documentation | **Estimated impact:** +6 points
#### 当前状态
CLAUDE.md exists (124 lines) but is missing: Common Patterns, Gotchas.
#### 实施步骤
1. Add a "## Common Patterns" section with relevant content
2. Add a "## Gotchas" section with relevant content
#### 验收标准
- [ ] CLAUDE.md contains a "Common Patterns" section
- [ ] CLAUDE.md contains a "Gotchas" section
```
## 许可证
MIT
标签:AI辅助编程, Claude Code集成, CLAUDE.md, Git worktree, GNU通用公共许可证, LLM友好性评估, MITM代理, Node.js, npm包, 上下文效率, 云安全监控, 代码分析工具, 代码可维护性, 代码结构优化, 代码评分系统, 威胁情报, 安全专业人员, 工程效率, 开发者工具, 数据可视化, 文档生成, 暗色界面, 自动化攻击, 静态分析