<div align="center">

# 🧠 FlowMind

### **The AI Agent That Learns How You Work**

*Memory and workflow automation for MCP, Codex, and 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)

[中文](README_CN.md) | [Quick Start](#quick-start) | [Demo](demo/DEMO.md) | [Detailed Guide](docs/guide.md) | [Integration](docs/integration-guide.md) | [Changelog](CHANGELOG.md)

</div>

Weekly downloads: 3,280

---

## What It Is

FlowMind is a memory layer for repeatable developer workflows.

Use it when you already have tools and want a better execution surface:

- Route recurring tasks through reusable skills
- Capture explicit feedback and reuse it later
- Run the same workflow from CLI, Codex, or MCP clients

Best-fit use cases today:

- Log and trace investigation
- Code review with fixed standards
- Data validation and internal tool orchestration

## Quick Start

```bash
npm install -g flowmind
flowmind doctor
flowmind skills
flowmind process --skill log-audit "query the latest error logs"
```

If you want Codex-friendly JSON output:

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

If you prefer `npx`:

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

## Why It Works

- Skills provide a stable execution path instead of ad hoc prompts
- Feedback becomes reusable state instead of chat history
- CLI and MCP entrypoints make the workflow scriptable

## A Real Example

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

On the next similar request, FlowMind can reuse that explicit formatting preference from local learning data.

## Read By Goal

- Need the full product walkthrough: [docs/guide.md](docs/guide.md)
- Need Claude Code, Codex, Cursor, or MCP setup: [docs/integration-guide.md](docs/integration-guide.md)
- Want to see terminal output first: [demo/DEMO.md](demo/DEMO.md)
- Want release history: [CHANGELOG.md](CHANGELOG.md)

## Why This Homepage Is Short

The npm package page works best as an entry page, not as the entire manual.
Detailed usage modes, system explanation, and architecture notes now live in the linked docs.

## Publish Notes

This project is published with a bypass-2FA token through a temporary npm user config:

```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
```

## Contributing

PRs are welcome. Start with [CONTRIBUTING.md](CONTRIBUTING.md).

## License

MIT. See [LICENSE](LICENSE).