# gin-admin-cli

**Repository Path**: mchongjs/gin-admin-cli

## Basic Information

- **Project Name**: gin-admin-cli
- **Description**: No description available
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-08-31
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# gin-admin-cli - [gin-admin](https://github.com/LyricTian/gin-admin)

> GinAdmin辅助工具

## 下载并使用

```bash
$ go get -u -v github.com/LyricTian/gin-admin-cli
```

### 创建项目

```bash
$ gin-admin-cli new -m -d 项目目录 -p 包名
```

> 使用示例

```
$ gin-admin-cli new -m -d ~/go/src/test-gin-admin -p test-gin-admin
```

### 生成业务模块

#### 指定模块名称和说明生成模块

```bash
$ gin-admin-cli g -d 项目目录 -p 包名 -n 结构体名称 -c 结构体注释说明
```

> 使用示例

```bash
$ gin-admin-cli g -d ./test-gin-admin -p test-gin-admin -n Task -c '任务管理'
```

#### 指定配置文件生成模块

```bash
$ gin-admin-cli g -d 项目目录 -p 包名 -f 配置文件(json)
```

> 配置文件说明

```json
{
  "struct_name": "结构体名称",
  "comment": "结构体注释说明",
  "fields": [
    {
      "struct_field_name": "结构体字段名称",
      "comment": "结构体字段注释",
      "struct_field_required": "结构体字段是否是必选项",
      "struct_field_type": "结构体字段类型",
      "gorm_options": "gorm配置项"
    }
  ]
}
```

> 使用示例

> 创建`task.json`文件

```json
{
  "struct_name": "Task",
  "comment": "任务管理",
  "fields": [
    {
      "struct_field_name": "RecordID",
      "comment": "记录ID",
      "struct_field_required": false,
      "struct_field_type": "string",
      "gorm_options": "size:36;index;"
    },
    {
      "struct_field_name": "Name",
      "comment": "任务名称",
      "struct_field_required": true,
      "struct_field_type": "string",
      "gorm_options": "size:50;index;"
    },
    {
      "struct_field_name": "Memo",
      "comment": "备注",
      "struct_field_required": false,
      "struct_field_type": "string",
      "gorm_options": "size:500;"
    },
    {
      "struct_field_name": "Creator",
      "comment": "创建者",
      "struct_field_required": false,
      "struct_field_type": "string",
      "gorm_options": "size:36;index;"
    }
  ]
}
```

```bash
$ gin-admin-cli g -d ./test-gin-admin -p test-gin-admin -f task.json
```

## MIT License

    Copyright (c) 2019 Lyric