aah CLI Tool
Here you will learn aah CLI flags, commands and it’s usage. It’s very handy for development, Continuous Integration (CI) and deployment preparation.
aah CLI is fully POSIX compliant flags (includes short and long versions) and command aliases too.
Available Commands
- Global Flags
-h, --help
- show help-v, --version
- print aah framework versions and go version
- list since v0.6
- new
- run
- build
- clean since v0.7
- help
- Cross Compile Build
Command: list
list
command, alias l
- scans GOPATH and lists all the import paths of aah project. since v0.6.
–––––––––––––––––––––––––––––––––––––––––––––––––––––
aah framework v0.7 - https://aahframework.org
–––––––––––––––––––––––––––––––––––––––––––––––––––––
# Report improvements/bugs at https://github.com/go-aah/aah/issues
Scanning GOPATH: /Users/jeeva/go/...
4 aah projects were found, import paths are:
github.com/go-aah/tutorials/domain-subdomain
github.com/go-aah/tutorials/html-minify
github.com/go-aah/tutorials/i18n
github.com/go-aah/website
Command: new
new
command, alias n
- helps you to quick start new aah Web and API application. It is interactive command. Just provide an appropriate inputs.
aah new
Command: run
run
command, alias r
- is used to run the aah application.
Note: It is recommended to use build
command to create build artifact and deploy it on server instead of using run command.
Supported options are-
-i value, --importpath value Import path of aah application
-e value, --envprofile value Environment profile name to activate. e.g: dev, qa, prod
-c value, --config value External config file for overriding aah.conf values
Use aah help run
to learn more.
Command: build
build
command, alias b
- is used to create aah application build artifact for deployment. Default location and name is <app-base-dir>/build/<app-binary-name>-<app-version>-<goos>-<goarch>.zip
or you can use your custom artifact name too.
Supported options are-
-i value, --importpath value Import path of aah application
-e value, --envprofile value Environment profile name to activate. e.g: dev, qa, prod
-o value, --output value Output of aah application build artifact. Default is '<app-base-dir>/build/<app-binary-name>-<app-version>-<goos>-<goarch>.zip'
Artifact naming convention:
<app-binary-name>-<app-version>-<goos>-<goarch>.zip
- For e.g.:
aahwebsite-381eaa8-darwin-amd64.zip
- For e.g.:
Use aah help build
to learn more.
Command: clean
clean
command, alias c
- is to clean generated files and build directory of the aah project.
Supported options are-
-i value, --importpath value Import path of aah application
Use aah help clean
to learn more.
Command: help
help
command alias h
- helps you to learn aah command usage.
# list of available commands
aah help
# to know about one command
aah help build
Cross Compile Build
Set environment variables GOOS
and GOARCH
before executing aah build
command. List of available GOOS and GOARCH values, click here.
Building linux binary on Mac OS
env GOOS=linux GOARCH=amd64 aah build --output=/Users/jeeva/build
#Output:
...
Your application artifact is here: /Users/jeeva/build/myapp-99bf7df-linux-amd64.zip
Building windows exe on Mac OS
env GOOS=windows GOARCH=amd64 aah build --output=/Users/jeeva/build
#Output:
...
Your application artifact is here: /Users/jeeva/build/myapp-99bf7df-windows-amd64.zip