# wiki-gen

**Repository Path**: andershsueh/wiki-gen

## Basic Information

- **Project Name**: wiki-gen
- **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-01-07
- **Last Updated**: 2026-01-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Wiki-Gen

一个使用AI分析源代码并生成WIKI文档的工具。

## 简介

Wiki-Gen是一个自动化工具，能够分析指定的代码仓库，并使用AI模型生成结构化的WIKI文档。生成的WIKI以HTML+SVG格式呈现，用户可以通过浏览器直接查看。

## 配置

Wiki-Gen 支持灵活的配置方式，您可以根据需要配置自己的AI模型：

### 1. 命令行参数配置（临时）

```bash
wiki-gen -create /path/to/your/repo -model_url http://your-ai-service:port -model your-model-name
```

### 2. 配置文件配置（持久）

在 `~/.wiki-gen/config.json` 创建配置文件：

```json
{
    "model_url": "http://your-ai-service:port",
    "model_name": "your-model-name",
    "request_timeout": 60,
    "max_content_length": 2000
}
```

### 3. 环境变量配置（会话级别）

```bash
export WIKI_GEN_MODEL_URL=http://your-ai-service:port
export WIKI_GEN_MODEL_NAME=your-model-name
wiki-gen -create /path/to/your/repo
```

配置优先级（从高到低）：
1. 命令行参数
2. 配置文件
3. 环境变量
4. 默认值（http://127.0.0.1:1234, qwen/qwen3-vl-4b）

## 安装

### 通过pip安装（推荐）

```bash
pip install wiki-gen
```

安装完成后，你可以直接使用`wiki-gen`命令：

```bash
wiki-gen -create /path/to/your/repo
```

### 通过pipx直接运行（类似npx）

如果你不想永久安装，可以使用pipx直接运行最新版本：

```bash
pipx run wiki-gen -create /path/to/your/repo
```

### 从源码安装

```bash
git clone https://github.com/yourusername/wiki-gen.git
cd wiki-gen
pip install .
```

## 使用方法

### 基本用法

```bash
wiki-gen -create /path/to/your/repo
```

### 完整参数说明

```
wiki-gen -create <repo_path> [options]

选项:
  -create, --repo_path     要分析的仓库路径（必需）
  -output, --output_dir    输出目录路径，默认为仓库路径下的wiki目录
  -model_url, --model_url  AI模型服务URL，默认从配置获取
  -model, --model_name     使用的AI模型名称，默认从配置获取
  -mock, --use_mock        使用模拟AI客户端进行测试
```

### 示例

1. 基本分析：
   ```bash
   wiki-gen -create /path/to/my/project
   ```

2. 指定输出目录：
   ```bash
   wiki-gen -create /path/to/my/project -output /path/to/output/wiki
   ```

3. 使用不同的AI模型服务：
   ```bash
   wiki-gen -create /path/to/my/project -model_url http://localhost:5000 -model my-model
   ```

4. 测试模式（不使用实际AI服务）：
   ```bash
   wiki-gen -create /path/to/my/project -mock
   ```

## 生成的WIKI内容

工具会生成以下内容：

- **HTML文档**: 包含项目概述、文件说明、代码结构等
- **SVG依赖图**: 可视化展示项目文件间的依赖关系
- **文件文档**: 每个源文件的AI生成说明

## 技术栈

- **编程语言**: Python 3.8+
- **AI模型接口**: 通过HTTP API与本地或远程AI服务通信
- **文档生成**: Jinja2模板引擎
- **可视化**: SVG生成用于依赖关系图

## 开发

### 本地开发设置

```bash
git clone https://github.com/yourusername/wiki-gen.git
cd wiki-gen
pip install -e .
```

### 构建独立可执行文件

```bash
pip install pyinstaller
pyinstaller wiki_gen.spec
```

构建的可执行文件将在`dist/`目录中。

## 贡献

欢迎提交Issue和Pull Request来改进这个项目！

## 许可证

MIT