summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/golang/README.md
diff options
context:
space:
mode:
authorAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
committerAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
commitedc449275b6c04445f58b108ca0937a87c1e8430 (patch)
tree9fd484d58145b616f29a78857cc0b1c8b1c18f05 /oh-my-zsh/plugins/golang/README.md
parent6f5424ca96c4221ef433f545642669e9c104d0ed (diff)
add zsh
Diffstat (limited to 'oh-my-zsh/plugins/golang/README.md')
-rw-r--r--oh-my-zsh/plugins/golang/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/golang/README.md b/oh-my-zsh/plugins/golang/README.md
new file mode 100644
index 0000000..128cc7f
--- /dev/null
+++ b/oh-my-zsh/plugins/golang/README.md
@@ -0,0 +1,40 @@
+# Golang plugin
+
+This plugin adds completion for the [Go Programming Language](https://golang.org/),
+as well as some aliases for common Golang commands.
+
+To use it, add `golang` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... golang)
+```
+
+## Aliases
+
+| Alias | Command | Description |
+| ------ | ----------------- | ------------------------------------------------------------- |
+| gob | `go build` | Build your code |
+| goc | `go clean` | Removes object files from package source directories |
+| god | `go doc` | Prints documentation comments |
+| goe | `go env` | Prints Go environment information |
+| gof | `go fmt` | Gofmt formats (aligns and indents) Go programs. |
+| gofa | `go fmt ./...` | Run go fmt for all packages in current directory, recursively |
+| gofx | `go fix` | Update packages to use a new API |
+| gog | `go get` | Downloads packages and then installs them to $GOPATH |
+| goga | `go get ./...` | Installs all dependencies in current directory, recursively |
+| goi | `go install` | Compiles and installs packages to $GOPATH |
+| gol | `go list` | Lists Go packages |
+| gom | `go mod` | Access to operations on modules |
+| gopa | `cd $GOPATH` | Takes you to `$GOPATH` |
+| gopb | `cd $GOPATH/bin` | Takes you to `$GOPATH/bin` |
+| gops | `cd $GOPATH/src` | Takes you to `$GOPATH/src` |
+| gor | `go run` | Compiles and runs your code |
+| got | `go test` | Runs tests |
+| gota | `go test ./...` | Runs tests in all subdirectories |
+| goto | `go tool` | Prints all the available tools |
+| gotoc | `go tool compile` | Generates object file |
+| gotod | `go tool dist` | Utility to bootstrap, build and test go runtime |
+| gotofx | `go tool fix` | Fixes an application to use newer features |
+| gov | `go vet` | Vet examines Go source code and reports suspicious constructs |
+| gove | `go version` | Prints Go version |
+| gow | `go work` | Work provides access to operations on workspaces |