# forge

**Repository Path**: Big-Van/forge

## Basic Information

- **Project Name**: forge
- **Description**: 快速搭建直接可用的后端框架工具
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-09
- **Last Updated**: 2026-05-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# Forge

一个基于模板的项目脚手架生成工具。

## 简介

Forge 是一个用于从预定义模板快速生成项目结构的命令行工具。通过简单的配置，即可生成包含完整项目架构的脚手架代码。

## 功能特性

- **模板渲染**: 支持 Jinja2 风格的模板变量替换
- **灵活配置**: 支持命令行变量 (`--var`) 或 JSON 配置文件 (`--context-file`)
- **CLI 接口**: 简洁的 Click 命令行工具
- **内置模板**: 提供 Flask 完整项目模板，包含：
  - Docker 配置
  - Celery 任务队列
  - RESTful API 结构
  - 数据库连接 (SQLAlchemy)
  - 配置管理

## 安装

```bash
pip install -e .
```

## 使用方法

### 基本用法

```bash
forge render --template flask --output ./myproject --var project_name=myproject
```

### 使用变量

```bash
forge render --template flask --output ./myproject --var project_name=myproject --var author=john
```

### 使用 JSON 配置文件

```bash
forge render --template flask --output ./myproject --context-file config.json
```

### 覆盖已存在的文件

```bash
forge render --template flask --output ./myproject --var project_name=myproject --overwrite
```

## 命令行选项

| 选项 | 说明 |
|------|------|
| `--template` | 模板名称 (如 flask) |
| `--output` | 输出目录 |
| `--var` | 模板变量，格式为 KEY=VALUE，可重复使用 |
| `--context-file` | JSON 格式的模板上下文文件 |
| `--overwrite` | 覆盖已存在的文件 |

## 项目结构

```
forge/
├── __main__.py          # 入口文件
├── core/
│   └── cli.py           # CLI 命令实现
└── templates/
    └── flask/           # Flask 模板
        ├── conf/        # 配置文件
        ├── docker/     # Docker 配置
        └── src/         # 源代码
```

## 许可证

MIT License