...
Run Format

Package get

import "cmd/go/internal/get"
Overview
Index

Overview ▾

Package get implements the “go get” command.

Variables

var CmdGet = &base.Command{
        UsageLine: "go get [-d] [-f] [-t] [-u] [-v] [-fix] [-insecure] [build flags] [packages]",
        Short:     "download and install packages and dependencies",
        Long: `
Get downloads the packages named by the import paths, along with their
dependencies. It then installs the named packages, like 'go install'.

The -d flag instructs get to stop after downloading the packages; that is,
it instructs get not to install the packages.

The -f flag, valid only when -u is set, forces get -u not to verify that
each package has been checked out from the source control repository
implied by its import path. This can be useful if the source is a local fork
of the original.

The -fix flag instructs get to run the fix tool on the downloaded packages
before resolving dependencies or building the code.

The -insecure flag permits fetching from repositories and resolving
custom domains using insecure schemes such as HTTP. Use with caution.

The -t flag instructs get to also download the packages required to build
the tests for the specified packages.

The -u flag instructs get to use the network to update the named packages
and their dependencies. By default, get uses the network to check out
missing packages but does not use it to look for updates to existing packages.

The -v flag enables verbose progress and debug output.

Get also accepts build flags to control the installation. See 'go help build'.

When checking out a new package, get creates the target directory
GOPATH/src/<import-path>. If the GOPATH contains multiple entries,
get uses the first one. For more details see: 'go help gopath'.

When checking out or updating a package, get looks for a branch or tag
that matches the locally installed version of Go. The most important
rule is that if the local installation is running version "go1", get
searches for a branch or tag named "go1". If no such version exists
it retrieves the default branch of the package.

When go get checks out or updates a Git repository,
it also updates any git submodules referenced by the repository.

Get never checks out or updates code stored in vendor directories.

For more about specifying packages, see 'go help packages'.

For more about how 'go get' finds source code to
download, see 'go help importpath'.

This text describes the behavior of get when using GOPATH
to manage source code and dependencies.
If instead the go command is running in module-aware mode,
the details of get's flags and effects change, as does 'go help get'.
See 'go help modules' and 'go help module-get'.

See also: go build, go install, go clean.
        `,
}
var HelpGopathGet = &base.Command{
        UsageLine: "gopath-get",
        Short:     "legacy GOPATH go get",
        Long: `
The 'go get' command changes behavior depending on whether the
go command is running in module-aware mode or legacy GOPATH mode.
This help text, accessible as 'go help gopath-get' even in module-aware mode,
describes 'go get' as it operates in legacy GOPATH mode.

Usage: ` + CmdGet.UsageLine + `
` + CmdGet.Long,
}
var (
        Insecure bool
)

func CheckImportPath

func CheckImportPath(path string) error

CheckImportPath checks that an import path is valid.

type ImportMismatchError

A ImportMismatchError is returned where metaImport/s are present but none match our import path.

type ImportMismatchError struct {
        // contains filtered or unexported fields
}

func (ImportMismatchError) Error

func (m ImportMismatchError) Error() string

type ModuleMode

ModuleMode specifies whether to prefer modules when looking up code sources.

type ModuleMode int
const (
        IgnoreMod ModuleMode = iota
        PreferMod
)

type RepoRoot

RepoRoot describes the repository root for a tree of source code.

type RepoRoot struct {
        Repo     string // repository URL, including scheme
        Root     string // import path corresponding to root of repo
        IsCustom bool   // defined by served <meta> tags (as opposed to hard-coded pattern)
        VCS      string // vcs type ("mod", "git", ...)
        // contains filtered or unexported fields
}

func RepoRootForImportPath

func RepoRootForImportPath(importPath string, mod ModuleMode, security web.SecurityMode) (*RepoRoot, error)

RepoRootForImportPath analyzes importPath to determine the version control system, and code repository to use.