diff --git a/SettingGOPATH.md b/SettingGOPATH.md index 42852fca..a177ec0a 100644 --- a/SettingGOPATH.md +++ b/SettingGOPATH.md @@ -1 +1,79 @@ -wait what? \ No newline at end of file +# Setting `GOPATH` + +The `GOPATH` environment variable specifies the location of your workspace. If no `GOPATH` is set, it is assumed to be `$HOME/go` on Unix systems and `%USERPROFILE%\go` on Windows. If you want to use a custom location as your workspace, you can set the `GOPATH` environment variable. This page explains how to set this variable on various platforms. + + +- [Unix systems](#unix-systems) + * [Bash](#bash) + * [Zsh](#zsh) + * [fish](#fish) +- [Windows](#windows) + +# Unix systems + +`GOPATH` can be any directory on your system. In Unix examples, we will set it to `$HOME/go` (since Go 1.8, it's a default `GOPATH` on Unix-like systems). Note that `GOPATH` must not be the same path as your Go installation. Another common setup is to set `GOPATH=$HOME`. + +## Bash + +Edit your `~/.bash_profile` to add the following line: +```bash +export GOPATH=$HOME/go +``` + +Save and exit your editor. Then, source your `~/.bash_profile`. +```bash +source ~/.bash_profile +``` + +> Note: Set the GOBIN path to generate a binary file when `go install` is run. +> ```bash +> export GOBIN=$HOME/go/bin +> ``` + +## Zsh + +Edit your `~/.zshrc` file to add the following line: + +```bash +export GOPATH=$HOME/go +``` +Save and exit your editor. Then, source your `~/.zshrc`. +```bash +$ source ~/.zshrc +``` + +## fish + +```bash +set -x -U GOPATH $HOME/go +``` +> The `-x` is used to specify that this variable should be exported +> and the `-U` makes this a universal variable, available to all sessions and +> persistent + +To set the GOBIN path: + +```bash +set -x -U GOBIN $GOPATH/bin +``` + +# Windows + +Your workspace can be located wherever you like, +but we'll use `C:\go-work` in this example. + +__NOTE:__ that `GOPATH` must not be the same path as your Go installation. + +* Create folder at `C:\go-work`. +* Right click on "Start" and click on "Control Panel". Select "System and Security", then click on "System". +* From the menu on the left, select the "Advanced systems settings". +* Click the "Environment Variables" button at the bottom. +* Click "New" from the "User variables" section. +* Type `GOPATH` into the "Variable name" field. +* Type `C:\go-work` into the "Variable value" field. +* Click OK. + +## Windows 10 +There is a faster way to edit `Environment Variables` with search +* Left click on "Search" and type `env` or `environment`. select `Edit environment variables for your account` +* and follow step above \ No newline at end of file