blob: d21446c67a893fba9a8b919666685b6fb8f79275 [file] [log] [blame]
// Copyright 2010 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
Goinstall is an experiment in automatic package installation.
It installs packages, possibly downloading them from the internet.
It maintains a list of public Go packages at
goinstall [flags] importpath...
Flags and default settings:
-dashboard=true tally public packages on
-update=false update already-downloaded packages
-v=false verbose operation
Goinstall installs each of the packages identified on the command line.
It installs a package's prerequisites before trying to install the package itself.
The source code for a package with import path foo/bar is expected
to be in the directory $GOROOT/src/pkg/foo/bar/. If the import
path refers to a code hosting site, goinstall will download the code
if necessary. The recognized code hosting sites are:
BitBucket (Mercurial)
import ""
import ""
GitHub (Git)
import ""
import ""
Google Code Project Hosting (Mercurial, Subversion)
import ""
import ""
import ""
import ""
If the destination directory (e.g., $GOROOT/src/pkg/
already exists and contains an appropriate checkout, goinstall will not
attempt to fetch updates. The -update flag changes this behavior,
causing goinstall to update all remote packages encountered during
the installation.
When downloading or updating, goinstall first looks for a tag or branch
named "release". If there is one, it uses that version of the code.
Otherwise it uses the default version selected by the version control
system, typically HEAD for git, tip for Mercurial.
After a successful download and installation of a publicly accessible
remote package, goinstall reports the installation to,
which increments a count associated with the package and the time
of its most recent installation. This mechanism powers the package list
at, allowing Go programmers
to learn about popular packages that might be worth looking at.
The -dashboard=false flag disables this reporting.
By default, goinstall prints output only when it encounters an error.
The -v flag causes goinstall to print information about packages
being considered and installed.
Goinstall does not attempt to be a replacement for make.
Instead, it invokes "make install" after locating the package sources.
For local packages without a Makefile and all remote packages,
goinstall creates and uses a temporary Makefile constructed from
the import path and the list of Go files in the package.
package documentation