DocsFlopCodeClaude Md

CLAUDE.md 项目配置

通过 CLAUDE.md 文件让 FlopCode 深度理解你的项目。

什么是 CLAUDE.md

CLAUDE.md 是放在项目根目录的配置文件，告诉 FlopCode 关于你项目的重要信息。每次对话开始时，FlopCode 会自动读取这个文件作为上下文。

自动生成

使用 /init 命令可以自动生成 CLAUDE.md：

/init

FlopCode 会分析你的项目结构、依赖、配置文件等，自动生成一份全面的项目指南。你可以在此基础上手动编辑和补充。

推荐内容结构

一个好的 CLAUDE.md 通常包含以下内容：

CLAUDE.md
# CLAUDE.md

## 项目概述
简要描述项目是什么、做什么。

## 技术栈
- 前端：React 18 + TypeScript + Tailwind CSS
- 后端：Node.js + Express + PostgreSQL
- 测试：Jest + React Testing Library

## 构建和运行
```bash
npm install     # 安装依赖
npm run dev     # 启动开发服务器
npm run test    # 运行测试
npm run build   # 生产构建
```

## 目录结构
```
src/
├── components/   # React 组件
├── pages/        # 页面路由
├── hooks/        # 自定义 hooks
├── utils/        # 工具函数
└── api/          # API 请求
```

## 代码规范
- 使用 ESLint + Prettier
- 组件使用函数式写法 + hooks
- 变量命名使用 camelCase

## 重要说明
- 数据库端口是 5433（不是默认的 5432）
- 环境变量在 .env.example 中有说明

最佳实践

  • 保持简洁 — 只写 FlopCode 需要知道的信息，避免冗余
  • 包含构建命令 — 让 FlopCode 知道如何运行、测试、构建项目
  • 说明非常规配置 — 特殊端口、自定义路径等容易踩坑的地方
  • 提交到 Git — 让团队成员共享项目配置
  • 及时更新 — 项目结构变化时同步更新 CLAUDE.md

大小限制

CLAUDE.md 文件建议控制在 40K 字符以内。过大的文件会占用过多上下文空间，影响对话质量。

配置层级

FlopCode 支持多级配置，优先级从低到高：

  • ~/.flopcode/CLAUDE.md — 全局配置（适用于所有项目）
  • 项目根目录/CLAUDE.md — 项目配置
  • 子目录/CLAUDE.md — 子项目配置