# gf-cli

**Repository Path**: GVIEW/gf-cli

## Basic Information

- **Project Name**: gf-cli
- **Description**: gf-cli是一款强大的GoFrame开发工具链，使得我们开发基于GoFrame框架的项目更加便捷。
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 5
- **Created**: 2021-03-24
- **Last Updated**: 2021-03-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# GF-CLI
[English](README.MD) | 简体中文

`gf-cli`是一款强大的[GoFrame](https://goframe.org)开发工具链，使得我们开发基于`GoFrame`框架的项目更加便捷。

## 1. 安装

### 1). 预编译二进制
我们推荐大家安装指定平台预编译的二进制文件：
- `Linux   (amd64)`: https://goframe.org/cli/linux_amd64/gf
- `Mac     (amd64)`: https://goframe.org/cli/darwin_amd64/gf
- `Windows (amd64)`: https://goframe.org/cli/windows_amd64/gf.exe
- [更多...](https://goframe.org/cli)

下载完成后，通过`gf install`命令安装。

1. `Mac`
    ```shell
    wget https://goframe.org/cli/darwin_amd64/gf && chmod +x gf && ./gf install
    ```
   > 如果您的终端使用的是`zsh`, 您需要执行`alias gf=gf`命令以便解决`gf`工具名称和`git fetch`简化指令冲突的问题。
                                                                                                                          
1. `Linux` 
    ```shell
    wget https://goframe.org/cli/linux_amd64/gf && chmod +x gf && ./gf install
    ```
                                                                                                                  
1. `Windows`

    下载后执行，随后根据提示执行安装。



### 2). 手动编译安装

1. 最新版本
    ```
    git clone https://github.com/gogf/gf-cli 
    cd gf-cli && go build main.go && ./main install
    ```
1. 指定版本
    ```
    git clone --branch v0.7.3 https://github.com/gogf/gf-cli 
    cd gf-cli && go build main.go && ./main install
    ```
> 注意：在`gf gen`命令中，由于`sqlite`和`oracle`数据库需要`cgo`和`gcc`支持，因此预编译的二进制中不提供对这两个数据库的支持，您需要手动修改源码，去掉对应源码文件中指定数据库类型的`import`注释后手动编译支持。

## 2. 命名
```html
$ gf
USAGE
    gf COMMAND [ARGUMENT] [OPTION]

COMMAND
    env        show current Golang environment variables
    get        install or update GF to system in default...
    gen        automatically generate go files for ORM models...
    mod        extra features for go modules...
    run        running go codes with hot-compiled-like feature...
    init       initialize an empty GF project at current working directory...
    help       show more information about a specified command
    pack       packing any file/directory to a resource file, or a go file...
    build      cross-building go project for lots of platforms...
    docker     create a docker image for current GF project...
    swagger    swagger feature for current project...
    update     update current gf binary to latest one (might need root/admin permission)
    install    install gf binary to system (might need root/admin permission)
    version    show current binary version info

OPTION
    -y         all yes for all command without prompt ask
    -?,-h      show this help or detail for specified command
    -v,-i      show version information

ADDITIONAL
    Use 'gf help COMMAND' or 'gf COMMAND -h' for detail about a command, which has '...'
    in the tail of their comments.
```

## 3. 文档

完善详尽的中文文档请参考`GoFrame`官网板块：[开发工具](https://itician.org/pages/viewpage.action?pageId=1114260)

## 4. FAQ

### 1). `gf run` 命令报错 `pipe: too many open files`

请执行`ulimit -n 65535`命令扩展您当前终端会话支持的最大文件打开数，随后再执行`gf run`。需要注意的是该命令仅对当前终端会话有效。