mirror of
https://github.com/beego/bee.git
synced 2024-12-22 20:20:49 +00:00
added help
This commit is contained in:
parent
478cbb39b9
commit
c33b57b605
66
README.md
66
README.md
@ -38,9 +38,37 @@ Bee provides a variety of commands which can be helpful at various stage of deve
|
||||
generate source code generator
|
||||
migrate run database migrations
|
||||
|
||||
### Shortcuts
|
||||
## bee version
|
||||
|
||||
Because you'll likely type these commands over and over, it makes sense to create aliases.
|
||||
The first command is the easiest: displaying which version of `bee`, `beego` and `go` is installed on your machine:
|
||||
|
||||
```bash
|
||||
$ bee version
|
||||
bee :1.2.2
|
||||
beego :1.4.0
|
||||
Go :go version go1.2.1 linux/amd64
|
||||
```
|
||||
|
||||
## bee new
|
||||
|
||||
|
||||
## bee run
|
||||
|
||||
## bee pack
|
||||
|
||||
## bee api
|
||||
|
||||
## bee bale
|
||||
|
||||
## bee migrate
|
||||
|
||||
## bee generate
|
||||
|
||||
|
||||
|
||||
## Shortcuts
|
||||
|
||||
Because you'll likely type these generator commands over and over, it makes sense to create aliases.
|
||||
|
||||
```bash
|
||||
# Generator Stuff
|
||||
@ -52,3 +80,37 @@ alias g:mi="bee generate migration"
|
||||
```
|
||||
|
||||
These can be stored in, for example, your `~/.bash_profile` or `~/.bashrc` files.
|
||||
|
||||
## Help
|
||||
|
||||
If you happend to forget the usage of a command, you can always find the usage information by `bee help <command>`.
|
||||
|
||||
For instance, to get more information about the `run` command:
|
||||
|
||||
```bash
|
||||
$ bee help run
|
||||
usage: bee new [appname]
|
||||
|
||||
create an application base on beego framework,
|
||||
|
||||
which in the current path with folder named [appname].
|
||||
|
||||
The [appname] folder has following structure:
|
||||
|
||||
|- main.go
|
||||
|- conf
|
||||
|- app.conf
|
||||
|- controllers
|
||||
|- default.go
|
||||
|- models
|
||||
|- routers
|
||||
|- router.go
|
||||
|- tests
|
||||
|- default_test.go
|
||||
|- static
|
||||
|- js
|
||||
|- css
|
||||
|- img
|
||||
|- views
|
||||
index.tpl
|
||||
```
|
Loading…
Reference in New Issue
Block a user