# 🦞 FengMing — 个人 AI 助手

<p align="center">
  <strong>你的本地 AI 助手，跑在你自己的设备上。</strong>
</p>

<p align="center">
  <a href="https://github.com/24K06/FengMing"><img src="https://img.shields.io/badge/GitHub-24K06%2FFengMing-181717?logo=github&style=for-the-badge" alt="GitHub"></a>
  <a href="https://gitee.com/lv06/fengming"><img src="https://img.shields.io/badge/Gitee-lv06%2Ffengming-C71D23?logo=gitee&style=for-the-badge" alt="Gitee"></a>
  <a href="https://www.npmjs.com/package/fengming"><img src="https://img.shields.io/npm/v/fengming?color=CB3837&logo=npm&style=for-the-badge" alt="npm"></a>
  <a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" alt="MIT License"></a>
</p>

**FengMing** 是基于 [OpenClaw](https://github.com/openclaw/openclaw) Fork 的国内优化版本，面向中文用户，专注于你真正需要的功能。

## 🎯 支持

| 类别           | 支持项                                           |
| -------------- | ------------------------------------------------ |
| **消息渠道**   | QQ、飞书、微信                                   |
| **模型提供商** | 豆包 (BytePlus)、通义千问 (Qwen)、混元 (Tencent) |
| **运行环境**   | Linux (推荐 WSL2)、Windows                       |

## 📦 安装

**环境要求：Node.js >= 22.16.0**

### 方式一：npm 全局安装

```bash
npm install -g fengming
fengming gateway install
fengming gateway start
```

### 方式二：一键安装脚本

```bash
curl -fsSL https://gitee.com/lv06/fengming/raw/master/scripts/install.sh | bash
```

安装完成后网关默认运行在 `http://127.0.0.1:19712`。

## ⚙️ 配置

配置文件：`~/.fengming/fengming.json`

```json5
{
  agent: {
    model: "qwen/deepseek-v4",
  },
  gateway: {
    port: 19712,
    auth: { mode: "none" },
  },
}
```

默认 `auth.mode: "none"`（仅本机访问），适合个人使用。

## 🚀 快速开始

```bash
# 启动网关
fengming gateway start

# 查看状态
fengming gateway status

# 发送消息
fengming message send --target <目标> --message "你好"

# 和助手对话
fengming agent --message "帮我查一下天气"
```

## 📁 项目结构

```
~/.fengming/
├── fengming.json      # 主配置
├── workspace/         # Agent 工作区
│   ├── AGENTS.md      # Agent 行为规则
│   ├── SOUL.md        # 人设定义
│   └── MEMORY.md      # 长期记忆
└── skills/            # 技能包
```

## 🔧 从源码构建

```bash
git clone https://github.com/24K06/FengMing.git
cd FengMing

pnpm install
pnpm build
pnpm ui:build
```

> ⚠️ Windows 上构建可能因内存不足失败，建议在 WSL2 ext4 文件系统下构建。

## 📄 命令参考

| 命令                                               | 说明           |
| -------------------------------------------------- | -------------- |
| `fengming gateway start`                           | 启动网关       |
| `fengming gateway stop`                            | 停止网关       |
| `fengming gateway status`                          | 网关状态       |
| `fengming gateway install`                         | 注册为系统服务 |
| `fengming agent --message <msg>`                   | 发送消息给助手 |
| `fengming message send --target <t> --message <m>` | 发送消息到渠道 |
| `fengming onboard`                                 | 初始化配置向导 |

## 🌐 仓库

- **GitHub（主仓库）**：https://github.com/24K06/FengMing
- **Gitee（国内镜像）**：https://gitee.com/lv06/fengming
- **npm**：https://www.npmjs.com/package/fengming

## 🙏 致谢

FengMing 基于 [OpenClaw](https://github.com/openclaw/openclaw) 构建，感谢原作者的出色工作。

## 📜 许可证

[MIT](LICENSE)
