# private-claw

**Repository Path**: ming_log/private-claw

## Basic Information

- **Project Name**: private-claw
- **Description**: 打造专属于个人的智能助手
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-23
- **Last Updated**: 2026-07-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Private Claw

课程设计、智能体实验和本地知识库示例仓库。

当前仓库包含课程规划文档、招聘智能体示例数据、Jupyter Notebook 实验材料，以及少量 Python 辅助脚本。

## 目录结构

- `docs/`: 课程规划、课程大纲和配套图片资料。
- `data/`: 示例知识库、岗位需求和候选人简历资料。
- `notebook/`: Jupyter Notebook 实验文件和本地提示词。
- `scripts/`: 辅助脚本，例如 Markdown 文档切分工具。
- `models/`: 本地模型文件目录，默认不提交到 Git。
- `main.py`: Python 项目入口示例。
- `pyproject.toml`: Python 项目配置和依赖声明。

## 环境准备

本项目使用 Python 3.12，并通过 `uv` 管理依赖。

```powershell
uv sync
```

如需配置 API Key 或其他本地密钥，请创建 `.env` 文件。`.env` 已在 `.gitignore` 中忽略，不应提交。

## 常用命令

查看项目文件：

```powershell
Get-ChildItem -Force
```

快速列出文件：

```powershell
rg --files
```

运行入口示例：

```powershell
uv run python main.py
```

启动 Jupyter：

```powershell
.\start_jupyter.bat
```

## 数据和模型

`data/` 目录用于同步课程和实验需要的示例资料，包括岗位需求、候选人资料和企业知识库内容。

`models/` 目录用于存放本地下载的模型文件，通常体积较大，已默认忽略。需要运行相关 Notebook 时，请根据实验内容自行准备模型文件。

Notebook 运行产生的 `notebook/chroma_db/`、`.ipynb_checkpoints/` 和缓存文件不会提交。

## 内容维护

- 长文档和课程大纲放在 `docs/`。
- 示例数据放在 `data/`，提交前确认不包含真实敏感信息。
- 本地密钥、模型文件、向量数据库和运行缓存不要提交。
- 新增 Markdown 文件优先使用小写 kebab-case 命名。