m_flow

环境要求

• Python 环境（pip 安装方式需要）
• Docker 与 Docker Compose（一键启动方式需要）
• 一个可用的 LLM API Key，例如 sk-xxxxxxxx
• Windows 用户需使用 PowerShell 执行 quickstart.ps1

安装与启动步骤

1. 1克隆仓库

   把项目源码拉取到本地并进入目录，后续所有命令都在此目录内执行。

   git clone https://github.com/FlowElement-xinliuyuansu/m_flow.git && cd m_flow

   复制

2. 2一键启动全栈

   脚本会检查环境、交互式配置 API Key，并启动后端+前端。Windows 改用 .quickstart.ps1。

   ./quickstart.sh

   复制

3. 3或使用 pip 安装

   不想用脚本可直接安装发布包，然后设置 LLM_API_KEY 环境变量。

   pip install mflow-ai
   export LLM_API_KEY="sk-..."

   复制

4. 4从源码安装

   开发者可做可编辑安装，便于修改代码后立即生效。

   git clone https://github.com/FlowElement-xinliuyuansu/m_flow.git && cd m_flow
   pip install -e .

   复制

5. 5运行示例代码

   在 Python 脚本中写入记忆、触发巩固，再按查询检索上下文。

   import asyncio
   import m_flow
   
   
   async def main():
       await m_flow.add("M-flow builds persistent memory for AI agents.")
       await m_flow.memorize()
       results = await m_flow.query("How does M-flow work?")
       for item in results.context:
           print(item)
   
   asyncio.run(main())

   复制

6. 6手动 Docker 部署

   用 compose 启动后端；加 profile 可同时启用前端、Neo4j 或 PostgreSQL+PGVector。

   docker compose up
   docker compose --profile ui up
   docker compose --profile neo4j up
   docker compose --profile postgres up

   复制

关键配置

如何确认成功

quickstart.sh 执行完毕且无报错，前端页面可访问，Python 示例能打印出检索结果即成功。

常见问题

注意事项

• quickstart.sh 会交互式询问 API Key，请提前准备好。
• Docker 启动参数较多，按需选择 profile，不要盲目全开。
• pip 安装后必须设置 LLM_API_KEY 环境变量，否则调用会失败。
• README 未给出默认端口，访问地址请以脚本输出和 docker compose 日志为准。