<div align="center">

# 🧠 FlowMind

### **学习你工作方式的 AI 智能体**

*面向 MCP、Codex、Claude Code 的记忆层与工作流自动化工具。*

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
[![npm version](https://img.shields.io/npm/v/flowmind.svg)](https://www.npmjs.com/package/flowmind)
[![npm downloads](https://img.shields.io/npm/dw/flowmind.svg)](https://www.npmjs.com/package/flowmind)

[English](README.md) | [快速开始](#快速开始) | [演示](demo/DEMO_CN.md) | [详细指南](docs/guide.zh-CN.md) | [集成指南](docs/integration-guide.md) | [更新记录](CHANGELOG.md)

</div>

本周下载量：3,280 次

---

## 它是什么

FlowMind 是一个面向重复开发工作流的记忆层。

它适合这样一类场景：你已经有工具，但希望执行入口更稳定：

- 把重复任务路由到可复用的 skill
- 把显式反馈沉淀下来，下次自动复用
- 让同一套工作流同时可用于 CLI、Codex 和 MCP 客户端

当前最适合的使用方向：

- 日志与 trace 排查
- 有固定标准的代码审查
- 数据校验和内部工具串联

## 快速开始

```bash
npm install -g flowmind
flowmind doctor
flowmind skills
flowmind process --skill log-audit "查询最近的错误日志"
```

如果你要给 Codex 或脚本消费 JSON：

```bash
flowmind-codex skills
flowmind-codex --skill log-audit "查询 traceId abc123 的日志"
```

如果你更想先用 `npx` 试一下：

```bash
npx flowmind@latest doctor
npx flowmind@latest skills
```

## 为什么它比直接写 Prompt 更稳

- skill 提供稳定执行路径，而不是每次重新组织 prompt
- 显式反馈会沉淀成状态，而不是停留在聊天记录里
- CLI / MCP 入口让工作流更容易脚本化和复用

## 一个真实例子

```bash
flowmind process --skill log-audit "查询 traceId abc123 的日志"
flowmind "下次用表格格式"
```

下次遇到相似请求时，FlowMind 可以从本地学习数据里复用这条显式偏好。

## 按目标阅读

- 想看完整产品说明： [docs/guide.zh-CN.md](docs/guide.zh-CN.md)
- 想看 Claude Code、Codex、Cursor、MCP 接入： [docs/integration-guide.md](docs/integration-guide.md)
- 想先看终端演示： [demo/DEMO_CN.md](demo/DEMO_CN.md)
- 想看版本变化： [CHANGELOG.md](CHANGELOG.md)

## 为什么首页改短了

npm 发布页更适合作为入口页，而不是整本使用手册。
更完整的使用方式、系统阐述和架构说明已经下沉到上面的独立文档。

## 发布说明

这个项目现在通过临时 npm userconfig + 支持 bypass-2FA 的 token 发布：

```bash
printf "//registry.npmjs.org/:_authToken=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\n" > /private/tmp/flowmind-npmrc
npm publish --access public --registry=https://registry.npmjs.org/ --userconfig /private/tmp/flowmind-npmrc
```

## 贡献

欢迎提交 PR。先看 [CONTRIBUTING.md](CONTRIBUTING.md)。

## 许可证

MIT，见 [LICENSE](LICENSE)。