# Config-Man 文档

本目录包含 Config-Man 项目的所有文档。

## 文档结构

- `README.md` - 文档索引
- `uv-tool.md` - `uv tool` 安装、运行、配置与发布说明
- `USAGE.md` - 命令使用说明，重点覆盖 `view`
- `cloudflare_setup.md` - Cloudflare 配置说明
- `progress-tracker.md` - 进度跟踪文档
- `requirements.md` - 需求文档
- `workplan.md` - 工作计划文档

## 快速开始

1. 从源码直接运行：

   ```bash
   uv tool run --from . config-man --help
   ```

2. 安装为本地工具：

   ```bash
   uv tool install --from . config-man
   config-man --help
   ```

3. 查看功能验证：

   ```bash
   config-man view --version 0.30 --mock
   ```

## 开发指南

1. 安装开发依赖：

   ```bash
   uv sync --extra dev
   ```

2. 运行测试：

   ```bash
   uv run pytest
   ```

3. 代码格式化：

   ```bash
   uv run black src/ tests/
   ```

4. 类型检查：

   ```bash
   uv run mypy src/
   ```