Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var Root struct { Init Init `cmd:"init" short:"i" help:"Setup a new Go module or application"` Build Build `cmd:"build" short:"b" help:"Build the Go application"` Run Run `cmd:"run" short:"r" help:"Run the Go application"` Test Test `cmd:"test" short:"t" help:"Run unit tests"` Uninstall Uninstall `cmd:"uninstall" short:"u" help:"Uninstall a 'go install' app."` Exec Do `cmd:"exec" short:"x" help:"Run a script from the manifest"` Bump Bump `cmd:"bump" help:"Bump the semantic version number in the manifest"` Todo Todo `cmd:"todo" help:"List all of the todo items found in the code base."` Kill Kill `cmd:"kill" short:"k" help:"Kill processes by executable name."` Version kong.VersionFlag `name:"version" short:"v" help:"Display the QuikGo version."` }
Functions ¶
This section is empty.
Types ¶
type Build ¶
type Build struct {
Bundle []string `name:"bundle" short:"b" type:"string" help:"Bundle the application into a tarball/zipball" enum:"zip,tar"`
OS []string `name:"os" type:"string" help:"The operating system(s) to build for (any options from 'go tool dist list' is valid)"`
WASM bool `name:"wasm" type:"bool" help:"Output a web assembly (OS is ignored when this option is true)"`
Output string `name:"output" short:"o" type:"string" help:"Output file name"`
Tips bool `name:"tips" short:"t" type:"bool" help:"Display tips in the generated commands"`
Minify bool `name:"minify" short:"m" type:"bool" help:"Set ldflags to strip debugging symbols and remove DWARF generations"`
Shrink bool `name:"shrink" short:"s" type:"bool" help:"Set gccgoflags to strip debugging symbols and remove DWARF generations"`
Compress bool `name:"compress" short:"c" type:"bool" help:"Compress with UPX"`
Tiny bool `name:"tiny" type:"bool" help:"Use tinygo (if available) instead of go to build."`
DryRun bool `name:"dry-run" short:"d" type:"bool" help:"Display the command without executing it."`
NoWork bool `name:"nowork" type:"bool" help:"Set GOWORK=off when building"`
Update bool `name:"update" short:"u" type:"bool" help:"Update (go mod tidy) before building."`
IgnoreCache bool `name:"no-cache" type:"bool" help:"Ignore the cache and rebuild, even if no Go files have changed."`
Profile []string `name:"profile" optional:"" help:"Name of the manifest.json profile attribute to apply."`
PreBuild []string `name:"prebuild" optional:"" help:"Run a command before building the application."`
PostBuild []string `name:"postbuild" optional:"" help:"Run a command after building the application."`
File string `arg:"source" optional:"" help:"Go source file (ex: main.go)"`
}
type Bump ¶ added in v1.0.7
type Bump struct {
Type string `` /* 143-byte string literal not displayed */
}
type Do ¶ added in v1.0.2
type Init ¶
type Init struct {
Overwrite bool `name:"overwrite" short:"o" help:"If a project already exist, overwrite with no backup and no prompt."`
}
type Kill ¶ added in v1.2.0
type Run ¶
type Run struct {
Bundle []string `name:"bundle" short:"b" type:"string" help:"Bundle the application into a tarball/zipball" enum:"zip,tar"`
OS []string `name:"os" type:"string" help:"The operating system(s) to build for (any option(s) from 'go tool dist list' is valid)"`
WASM bool `name:"wasm" type:"bool" help:"Output a web assembly (OS is ignored when this option is true)"`
Output string `name:"output" short:"o" type:"string" help:"Output file name"`
Tips bool `name:"tips" short:"t" type:"bool" help:"Display tips in the generated commands"`
Minify bool `name:"minify" short:"m" type:"bool" help:"Set ldflags to strip debugging symbols and remove DWARF generations"`
Shrink bool `name:"shrink" short:"s" type:"bool" help:"Set gccgoflags to strip debugging symbols and remove DWARF generations"`
DryRun bool `name:"dry-run" short:"d" type:"bool" help:"Display the command without executing it."`
NoWork bool `name:"no-work" type:"bool" help:"Set GOWORK=off when building"`
Update bool `name:"update" short:"u" type:"bool" help:"Update (go mod tidy) before building."`
Port int `name:"port" short:"p" help:"The port to run the HTTP server on (WASM only)."`
IgnoreCache bool `name:"no-cache" type:"bool" help:"Ignore the cache and rebuild, even if no Go files have changed."`
Profile []string `name:"profile" optional:"" help:"Name of the manifest.json profile attribute to apply."`
Prekill bool `name:"prekill" type:"bool" help:"Run 'qgo kill' before running the command."`
PreRun []string `name:"prerun" optional:"" help:"Run a command before running the application."`
PostRun []string `name:"postrun" optional:"" help:"Run a command after running the application."`
PreBuild []string `name:"prebuild" optional:"" help:"Run a command before building the application."`
PostBuild []string `name:"postbuild" optional:"" help:"Run a command after building the application."`
File string `arg:"source" optional:"" help:"Go source file (ex: main.go)"`
Args []string `arg:"" optional:"" help:"Arguments to pass to the executable."`
}
type TestResult ¶
type Todo ¶ added in v1.0.7
Click to show internal directories.
Click to hide internal directories.