# biz-memory

**Repository Path**: yangsj/biz-memory

## Basic Information

- **Project Name**: biz-memory
- **Description**: No description available
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-17
- **Last Updated**: 2026-04-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# BizMemory

BizMemory 是一个面向团队协作的业务知识库服务，提供：

- Web 管理界面
- REST API
- MCP Streamable HTTP 接口
- Skill 下载接口
- 团队 Skill 管理与分发

常用文档：

- 安装与启动：[docs/INSTALL.md](/Users/yangshuangjun/learn/biz-memory/docs/INSTALL.md)
- 系统设计：[docs/SYSTEM_DESIGN.md](/Users/yangshuangjun/learn/biz-memory/docs/SYSTEM_DESIGN.md)
- 文档索引：[docs/README.md](/Users/yangshuangjun/learn/biz-memory/docs/README.md)

## 快速开始

### 环境要求

- Python 3.9+
- PostgreSQL 16+
- `biz_memory` 数据库

### 安装依赖

```bash
cd /Users/yangshuangjun/learn/biz-memory
pip install fastapi asyncpg pydantic python-dotenv httpx uvicorn python-multipart
```

### 配置数据库

默认连接配置：

- `DB_HOST=localhost`
- `DB_PORT=5432`
- `DB_NAME=biz_memory`
- `DB_USER=yangshuangjun`
- `DB_PASSWORD=` 空字符串

创建数据库与扩展：

```bash
createdb biz_memory
psql -d biz_memory -c "CREATE EXTENSION IF NOT EXISTS vector;"
```

如果是新库，再执行示例数据初始化：

```bash
python3 scripts/init_data.py
```

### 一键启动

本机访问：

```bash
./scripts/start.sh
```

局域网访问：

```bash
./scripts/start.sh --host 0.0.0.0
```

### 手动启动

```bash
python3 -m uvicorn src.api.main:app --host 127.0.0.1 --port 8000
```

### 后台运行

临时后台运行：

```bash
nohup bash scripts/start.sh --host 0.0.0.0 --port 8000 > biz-memory.out 2>&1 &
```

查看日志：

```bash
tail -f /Users/yangshuangjun/learn/biz-memory/biz-memory.out
```

停止服务：

```bash
pkill -f "uvicorn src.api.main:app"
```

如果希望关掉终端后继续保留交互会话，推荐使用 `tmux`：

```bash
tmux new -s biz-memory
bash scripts/start.sh --host 0.0.0.0 --port 8000
```

## 访问地址

本机：

- Web: `http://127.0.0.1:8000`
- MCP: `http://127.0.0.1:8000/mcp`
- Skill: `http://127.0.0.1:8000/api/skill/biz-memory`

局域网：

- Web: `http://<你的局域网IP>:8000`
- MCP: `http://<你的局域网IP>:8000/mcp`
- Skill: `http://<你的局域网IP>:8000/api/skill/biz-memory`

## Skill 管理

进入 Web 首页后，顶部导航新增了 `Skills` 入口。

当前支持三种团队协作方式：

- 通过浏览器上传 Skill 目录
- 浏览器不支持目录上传时，直接上传 zip 包
- 通过本机管理端导入本地路径，例如 `~/.codex/skills/<skill-name>`

限制说明：

- `本地路径导入` 仅允许从服务所在机器发起
- 本地路径必须位于这些目录之一：
  - `<项目>/skills`
  - `~/.codex/skills`
  - `~/.claude/skills`
- 禁用状态的 Skill 不再提供安装命令和下载链接

## 验证启动

```bash
curl http://127.0.0.1:8000/health
```

预期返回：

```json
{"status":"ok"}
```