Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gogf/gf-cli
GoFrame Command Line Interface, which is your helpmate for building GoFrame application with convenience.
https://github.com/gogf/gf-cli
autobuild cli crossbuild generator gf goframe grpc model orm packer proto protobuf protobuf3 swagger
Last synced: 9 days ago
JSON representation
GoFrame Command Line Interface, which is your helpmate for building GoFrame application with convenience.
- Host: GitHub
- URL: https://github.com/gogf/gf-cli
- Owner: gogf
- License: mit
- Archived: true
- Created: 2019-06-27T11:59:24.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-11-14T04:01:52.000Z (about 2 years ago)
- Last Synced: 2024-09-30T15:41:45.502Z (4 months ago)
- Topics: autobuild, cli, crossbuild, generator, gf, goframe, grpc, model, orm, packer, proto, protobuf, protobuf3, swagger
- Language: Go
- Homepage: https://goframe.org
- Size: 7.39 MB
- Stars: 255
- Watchers: 15
- Forks: 105
- Open Issues: 44
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
> 👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣
>
> This repo. is archived and moved to https://github.com/gogf/gf/tree/master/cmd/gf for better maintenance.
>
> 👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣👣
# GoFrame CLI TOOL
`gf` is a powerful CLI tool for building [GoFrame](https://goframe.org) application with convenience.
## 1. Install
### 1). Manually Install
> You might need setting the goproxy to make through building.
> Please make sure your Golang version > v1.15.
1. Latest version
```
go install github.com/gogf/gf-cli/v2/gf@master
```
2. Specified version
```
go install github.com/gogf/gf-cli/v2/[email protected]
```
3. Check installation
```
gf -v
```
### 2). PreBuilt Binary
You can also install `gf` tool using pre-built binaries: https://github.com/gogf/gf-cli/releases
After downloads, please use `gf_xxx_xxx install` command to install gf binary to system binary path.
1. `Mac`
```shell
wget -O gf https://github.com/gogf/gf-cli/releases/download/v2.0.0-rc/gf_darwin_amd64 && chmod +x gf && ./gf install
```
> If you're using `zsh`, you might need rename your alias by command `alias gf=gf` to resolve the conflicts between `gf` and `git fetch`.
2. `Linux`
```shell
wget -O gf https://github.com/gogf/gf-cli/releases/download/v2.0.0-rc/gf_linux_amd64 && chmod +x gf && ./gf install
```
3. `Windows`
Manually download, execute it and then follow the instruction.
4. Database `sqlite` and `oracle` are not support in `gf gen` command in default as it needs `cgo` and `gcc`, you can manually make some changes to the source codes and do the building.
## 2. Commands
```html
$ gf
USAGE
gf COMMAND [OPTION]
COMMAND
env show current Golang environment variables
run running go codes with hot-compiled-like feature
gen automatically generate go files for dao/do/entity/pb/pbentity
tpl template parsing and building commands
init create and initialize an empty GoFrame project
pack packing any file/directory to a resource file, or a go file
build cross-building go project for lots of platforms
docker build docker image for current GoFrame project
install install gf binary to system (might need root/admin permission)
version show version information of current binary
OPTION
-y, --yes all yes for all command without prompt ask
-v, --version show version information of current binary
-d, --debug show internal detailed debugging information
-h, --help more information about this command
ADDITIONAL
Use "gf COMMAND -h" for details about a command.
```
## 3. FAQ
### 1). Command `gf run` returns `pipe: too many open files`
Please use `ulimit -n 65535` to enlarge your system configuration for max open files for current terminal shell session, and then `gf run`.