You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
316 lines
9.1 KiB
316 lines
9.1 KiB
<!--{
|
|
"Title": "Getting Started",
|
|
"Path": "/doc/install"
|
|
}-->
|
|
|
|
<div class="hideFromDownload">
|
|
|
|
<h2 id="download">Download the Go distribution</h2>
|
|
|
|
<p>
|
|
<a href="/dl/" id="start" class="download">
|
|
<span class="big">Download Go</span>
|
|
<span class="desc">Click here to visit the downloads page</span>
|
|
</a>
|
|
</p>
|
|
|
|
<p>
|
|
<a href="/dl/" target="_blank">Official binary
|
|
distributions</a> are available for the FreeBSD (release 10-STABLE and above),
|
|
Linux, macOS (10.11 and above), and Windows operating systems and
|
|
the 32-bit (<code>386</code>) and 64-bit (<code>amd64</code>) x86 processor
|
|
architectures.
|
|
</p>
|
|
|
|
<p>
|
|
If a binary distribution is not available for your combination of operating
|
|
system and architecture, try
|
|
<a href="/doc/install/source">installing from source</a> or
|
|
<a href="/doc/install/gccgo">installing gccgo instead of gc</a>.
|
|
</p>
|
|
|
|
|
|
<h2 id="requirements">System requirements</h2>
|
|
|
|
<p>
|
|
Go <a href="/dl/">binary distributions</a> are available for these supported operating systems and architectures.
|
|
Please ensure your system meets these requirements before proceeding.
|
|
If your OS or architecture is not on the list, you may be able to
|
|
<a href="/doc/install/source">install from source</a> or
|
|
<a href="/doc/install/gccgo">use gccgo instead</a>.
|
|
</p>
|
|
|
|
<table class="codetable" frame="border" summary="requirements">
|
|
<tr>
|
|
<th align="center">Operating system</th>
|
|
<th align="center">Architectures</th>
|
|
<th align="center">Notes</th>
|
|
</tr>
|
|
<tr><td colspan="3"><hr></td></tr>
|
|
<tr><td>FreeBSD 10.3 or later</td> <td>amd64, 386</td> <td>Debian GNU/kFreeBSD not supported</td></tr>
|
|
<tr valign='top'><td>Linux 2.6.23 or later with glibc</td> <td>amd64, 386, arm, arm64,<br>s390x, ppc64le</td> <td>CentOS/RHEL 5.x not supported.<br>Install from source for other libc.</td></tr>
|
|
<tr><td>macOS 10.11 or later</td> <td>amd64</td> <td>use the clang or gcc<sup>†</sup> that comes with Xcode<sup>‡</sup> for <code>cgo</code> support</td></tr>
|
|
<tr valign='top'><td>Windows 7, Server 2008R2 or later</td> <td>amd64, 386</td> <td>use MinGW (<code>386</code>) or MinGW-W64 (<code>amd64</code>) gcc<sup>†</sup>.<br>No need for cygwin or msys.</td></tr>
|
|
</table>
|
|
|
|
<p>
|
|
<sup>†</sup>A C compiler is required only if you plan to use
|
|
<a href="/cmd/cgo">cgo</a>.<br/>
|
|
<sup>‡</sup>You only need to install the command line tools for
|
|
<a href="https://developer.apple.com/Xcode/">Xcode</a>. If you have already
|
|
installed Xcode 4.3+, you can install it from the Components tab of the
|
|
Downloads preferences panel.
|
|
</p>
|
|
|
|
</div><!-- hideFromDownload -->
|
|
|
|
|
|
<h2 id="install">Install the Go tools</h2>
|
|
|
|
<p>
|
|
If you are upgrading from an older version of Go you must
|
|
first <a href="#uninstall">remove the existing version</a>.
|
|
</p>
|
|
|
|
<div id="tarballInstructions">
|
|
|
|
<h3 id="tarball">Linux, macOS, and FreeBSD tarballs</h3>
|
|
|
|
<p>
|
|
<a href="/dl/">Download the archive</a>
|
|
and extract it into <code>/usr/local</code>, creating a Go tree in
|
|
<code>/usr/local/go</code>. For example:
|
|
</p>
|
|
|
|
<pre>
|
|
tar -C /usr/local -xzf <span class="downloadFilename">go$VERSION.$OS-$ARCH.tar.gz</span>
|
|
</pre>
|
|
|
|
<p class="hideFromDownload">
|
|
Choose the archive file appropriate for your installation.
|
|
For instance, if you are installing Go version 1.2.1 for 64-bit x86 on Linux,
|
|
the archive you want is called <code>go1.2.1.linux-amd64.tar.gz</code>.
|
|
</p>
|
|
|
|
<p>
|
|
(Typically these commands must be run as root or through <code>sudo</code>.)
|
|
</p>
|
|
|
|
<p>
|
|
Add <code>/usr/local/go/bin</code> to the <code>PATH</code> environment
|
|
variable. You can do this by adding this line to your <code>/etc/profile</code>
|
|
(for a system-wide installation) or <code>$HOME/.profile</code>:
|
|
</p>
|
|
|
|
<pre>
|
|
export PATH=$PATH:/usr/local/go/bin
|
|
</pre>
|
|
|
|
<p>
|
|
<b>Note</b>: changes made to a <code>profile</code> file may not apply until the
|
|
next time you log into your computer.
|
|
To apply the changes immediately, just run the shell commands directly
|
|
or execute them from the profile using a command such as
|
|
<code>source $HOME/.profile</code>.
|
|
</p>
|
|
|
|
</div><!-- tarballInstructions -->
|
|
|
|
<div id="darwinPackageInstructions">
|
|
|
|
<h3 id="macos"><div id="osx"></div>macOS package installer</h3>
|
|
|
|
<p>
|
|
<a href="/dl/">Download the package file</a>,
|
|
open it, and follow the prompts to install the Go tools.
|
|
The package installs the Go distribution to <code>/usr/local/go</code>.
|
|
</p>
|
|
|
|
<p>
|
|
The package should put the <code>/usr/local/go/bin</code> directory in your
|
|
<code>PATH</code> environment variable. You may need to restart any open
|
|
Terminal sessions for the change to take effect.
|
|
</p>
|
|
|
|
</div><!-- darwinPackageInstructions -->
|
|
|
|
<div id="windowsInstructions">
|
|
|
|
<h3 id="windows">Windows</h3>
|
|
|
|
<p class="hideFromDownload">
|
|
The Go project provides two installation options for Windows users
|
|
(besides <a href="/doc/install/source">installing from source</a>):
|
|
a zip archive that requires you to set some environment variables and an
|
|
MSI installer that configures your installation automatically.
|
|
</p>
|
|
|
|
<div id="windowsInstallerInstructions">
|
|
|
|
<h4 id="windows_msi">MSI installer</h4>
|
|
|
|
<p>
|
|
Open the <a href="/dl/">MSI file</a>
|
|
and follow the prompts to install the Go tools.
|
|
By default, the installer puts the Go distribution in <code>c:\Go</code>.
|
|
</p>
|
|
|
|
<p>
|
|
The installer should put the <code>c:\Go\bin</code> directory in your
|
|
<code>PATH</code> environment variable. You may need to restart any open
|
|
command prompts for the change to take effect.
|
|
</p>
|
|
|
|
</div><!-- windowsInstallerInstructions -->
|
|
|
|
<div id="windowsZipInstructions">
|
|
|
|
<h4 id="windows_zip">Zip archive</h4>
|
|
|
|
<p>
|
|
<a href="/dl/">Download the zip file</a> and extract it into the directory of your choice (we suggest <code>c:\Go</code>).
|
|
</p>
|
|
|
|
<p>
|
|
Add the <code>bin</code> subdirectory of your Go root (for example, <code>c:\Go\bin</code>) to your <code>PATH</code> environment variable.
|
|
</p>
|
|
|
|
</div><!-- windowsZipInstructions -->
|
|
|
|
<h4 id="windows_env">Setting environment variables under Windows</h4>
|
|
|
|
<p>
|
|
Under Windows, you may set environment variables through the "Environment
|
|
Variables" button on the "Advanced" tab of the "System" control panel. Some
|
|
versions of Windows provide this control panel through the "Advanced System
|
|
Settings" option inside the "System" control panel.
|
|
</p>
|
|
|
|
</div><!-- windowsInstructions -->
|
|
|
|
|
|
<h2 id="testing">Test your installation</h2>
|
|
|
|
<p>
|
|
Check that Go is installed correctly by building a simple program, as follows.
|
|
</p>
|
|
|
|
<p>
|
|
Create a file named <code>hello.go</code> that looks like:
|
|
</p>
|
|
|
|
<pre>
|
|
package main
|
|
|
|
import "fmt"
|
|
|
|
func main() {
|
|
fmt.Printf("hello, world\n")
|
|
}
|
|
</pre>
|
|
|
|
<p>
|
|
Then build it with the <code>go</code> tool:
|
|
</p>
|
|
|
|
<pre class="testUnix">
|
|
$ <b>go build hello.go</b>
|
|
</pre>
|
|
|
|
<pre class="testWindows">
|
|
C:\Users\Gopher\go\src\hello> <b>go build hello.go</b>
|
|
</pre>
|
|
|
|
<p>
|
|
The command above will build an executable named
|
|
<code class="testUnix">hello</code><code class="testWindows">hello.exe</code>
|
|
in the current directory alongside your source code.
|
|
Execute it to see the greeting:
|
|
</p>
|
|
|
|
<pre class="testUnix">
|
|
$ <b>./hello</b>
|
|
hello, world
|
|
</pre>
|
|
|
|
<pre class="testWindows">
|
|
C:\Users\Gopher\go\src\hello> <b>hello</b>
|
|
hello, world
|
|
</pre>
|
|
|
|
<p>
|
|
If you see the "hello, world" message then your Go installation is working.
|
|
</p>
|
|
|
|
<p>
|
|
Before rushing off to write Go code please read the
|
|
<a href="/doc/code.html">How to Write Go Code</a> document,
|
|
which describes some essential concepts about using the Go tools.
|
|
</p>
|
|
|
|
|
|
<h2 id="extra_versions">Installing extra Go versions</h2>
|
|
|
|
<p>
|
|
It may be useful to have multiple Go versions installed on the same machine, for
|
|
example, to ensure that a package's tests pass on multiple Go versions.
|
|
Once you have one Go version installed, you can install another (such as 1.10.7)
|
|
as follows:
|
|
</p>
|
|
|
|
<pre>
|
|
$ go get golang.org/dl/go1.10.7
|
|
$ go1.10.7 download
|
|
</pre>
|
|
|
|
<p>
|
|
The newly downloaded version can be used like <code>go</code>:
|
|
</p>
|
|
|
|
<pre>
|
|
$ go1.10.7 version
|
|
go version go1.10.7 linux/amd64
|
|
</pre>
|
|
|
|
<p>
|
|
All Go versions available via this method are listed on
|
|
<a href="https://godoc.org/golang.org/dl#pkg-subdirectories">the download page</a>.
|
|
You can find where each of these extra Go versions is installed by looking
|
|
at its <code>GOROOT</code>; for example, <code>go1.10.7 env GOROOT</code>.
|
|
To uninstall a downloaded version, just remove its <code>GOROOT</code> directory
|
|
and the <code>goX.Y.Z</code> binary.
|
|
</p>
|
|
|
|
|
|
<h2 id="uninstall">Uninstalling Go</h2>
|
|
|
|
<p>
|
|
To remove an existing Go installation from your system delete the
|
|
<code>go</code> directory. This is usually <code>/usr/local/go</code>
|
|
under Linux, macOS, and FreeBSD or <code>c:\Go</code>
|
|
under Windows.
|
|
</p>
|
|
|
|
<p>
|
|
You should also remove the Go <code>bin</code> directory from your
|
|
<code>PATH</code> environment variable.
|
|
Under Linux and FreeBSD you should edit <code>/etc/profile</code> or
|
|
<code>$HOME/.profile</code>.
|
|
If you installed Go with the <a href="#macos">macOS package</a> then you
|
|
should remove the <code>/etc/paths.d/go</code> file.
|
|
Windows users should read the section about <a href="#windows_env">setting
|
|
environment variables under Windows</a>.
|
|
</p>
|
|
|
|
|
|
<h2 id="help">Getting help</h2>
|
|
|
|
<p>
|
|
For help, see the <a href="/help/">list of Go mailing lists, forums, and places to chat</a>.
|
|
</p>
|
|
|
|
<p>
|
|
Report bugs either by running “<b><code>go</code> <code>bug</code></b>”, or
|
|
manually at the <a href="https://golang.org/issue">Go issue tracker</a>.
|
|
</p>
|