README
¶
Go Tools
This subrepository holds the source for various packages and tools that support the Go programming language.
Some of the tools, godoc and vet for example, are included in binary Go
distributions.
Others, including the Go guru and the test coverage tool, can be fetched with
go get.
Packages include a type-checker for Go and an implementation of the Static Single Assignment form (SSA) representation for Go programs.
Download/Install
The easiest way to install is to run go get -u golang.org/x/tools/.... You can
also manually git clone the repository to $GOPATH/src/golang.org/x/tools.
Report Issues / Send Patches
This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://golang.org/doc/contribute.html.
The main issue tracker for the tools repository is located at https://github.com/golang/go/issues. Prefix your issue with "x/tools/(your subdir):" in the subject line, so it is easy to find.
Directories
¶
| Path | Synopsis |
|---|---|
|
benchmark
|
|
|
parse
Package parse provides support for parsing benchmark results as generated by 'go test -bench'.
|
Package parse provides support for parsing benchmark results as generated by 'go test -bench'. |
|
Package blog implements a web server for articles written in present format.
|
Package blog implements a web server for articles written in present format. |
|
atom
Package atom defines XML data structures for an Atom feed.
|
Package atom defines XML data structures for an Atom feed. |
|
cmd
|
|
|
benchcmp
The benchcmp command displays performance changes between benchmarks.
|
The benchcmp command displays performance changes between benchmarks. |
|
bundle
Bundle creates a single-source-file version of a source package suitable for inclusion in a particular target package.
|
Bundle creates a single-source-file version of a source package suitable for inclusion in a particular target package. |
|
callgraph
callgraph: a tool for reporting the call graph of a Go program.
|
callgraph: a tool for reporting the call graph of a Go program. |
|
compilebench
Compilebench benchmarks the speed of the Go compiler.
|
Compilebench benchmarks the speed of the Go compiler. |
|
cover
Cover is a program for analyzing the coverage profiles generated by 'go test -coverprofile=cover.out'.
|
Cover is a program for analyzing the coverage profiles generated by 'go test -coverprofile=cover.out'. |
|
digraph
The digraph command performs queries over unlabelled directed graphs represented in text form.
|
The digraph command performs queries over unlabelled directed graphs represented in text form. |
|
eg
The eg command performs example-based refactoring.
|
The eg command performs example-based refactoring. |
|
fiximports
The fiximports command fixes import declarations to use the canonical import path for packages that have an "import comment" as defined by https://golang.org/s/go14customimport.
|
The fiximports command fixes import declarations to use the canonical import path for packages that have an "import comment" as defined by https://golang.org/s/go14customimport. |
|
getgo
The getgo command installs Go to the user's system.
|
The getgo command installs Go to the user's system. |
|
getgo/server
Command server serves get.golang.org, redirecting users to the appropriate getgo installer based on the request path.
|
Command server serves get.golang.org, redirecting users to the appropriate getgo installer based on the request path. |
|
go-contrib-init
The go-contrib-init command helps new Go contributors get their development environment set up for the Go contribution process.
|
The go-contrib-init command helps new Go contributors get their development environment set up for the Go contribution process. |
|
godex
The godex command prints (dumps) exported information of packages or selected package objects.
|
The godex command prints (dumps) exported information of packages or selected package objects. |
|
godoc
Godoc extracts and generates documentation for Go programs.
|
Godoc extracts and generates documentation for Go programs. |
|
goimports
Command goimports updates your Go import lines, adding missing ones and removing unreferenced ones.
|
Command goimports updates your Go import lines, adding missing ones and removing unreferenced ones. |
|
gomvpkg
The gomvpkg command moves go packages, updating import declarations.
|
The gomvpkg command moves go packages, updating import declarations. |
|
gorename
The gorename command performs precise type-safe renaming of identifiers in Go source code.
|
The gorename command performs precise type-safe renaming of identifiers in Go source code. |
|
gotype
The gotype command, like the front-end of a Go compiler, parses and type-checks a single Go package.
|
The gotype command, like the front-end of a Go compiler, parses and type-checks a single Go package. |
|
goyacc
Goyacc is a version of yacc for Go.
|
Goyacc is a version of yacc for Go. |
|
guru
guru: a tool for answering questions about Go source code.
|
guru: a tool for answering questions about Go source code. |
|
guru/serial
Package serial defines the guru's schema for -json output.
|
Package serial defines the guru's schema for -json output. |
|
heapview
heapview is a tool for viewing Go heap dumps.
|
heapview is a tool for viewing Go heap dumps. |
|
heapview/internal/core
Package core provides functions for reading core dumps and examining their contained heaps.
|
Package core provides functions for reading core dumps and examining their contained heaps. |
|
html2article
This program takes an HTML file and outputs a corresponding article file in present format.
|
This program takes an HTML file and outputs a corresponding article file in present format. |
|
present
Present displays slide presentations and articles.
|
Present displays slide presentations and articles. |
|
ssadump
ssadump: a tool for displaying and interpreting the SSA form of Go programs.
|
ssadump: a tool for displaying and interpreting the SSA form of Go programs. |
|
stress
The stress utility is intended for catching sporadic failures.
|
The stress utility is intended for catching sporadic failures. |
|
stringer
Stringer is a tool to automate the creation of methods that satisfy the fmt.Stringer interface.
|
Stringer is a tool to automate the creation of methods that satisfy the fmt.Stringer interface. |
|
tip
Command tip is the tip.golang.org server, serving the latest HEAD straight from the Git oven.
|
Command tip is the tip.golang.org server, serving the latest HEAD straight from the Git oven. |
|
toolstash
Toolstash provides a way to save, run, and restore a known good copy of the Go toolchain and to compare the object files generated by two toolchains.
|
Toolstash provides a way to save, run, and restore a known good copy of the Go toolchain and to compare the object files generated by two toolchains. |
|
container
|
|
|
intsets
Package intsets provides Sparse, a compact and fast representation for sparse sets of int values.
|
Package intsets provides Sparse, a compact and fast representation for sparse sets of int values. |
|
Package cover provides support for parsing coverage profiles generated by "go test -coverprofile=cover.out".
|
Package cover provides support for parsing coverage profiles generated by "go test -coverprofile=cover.out". |
|
go
|
|
|
ast/astutil
Package astutil contains common utilities for working with the Go AST.
|
Package astutil contains common utilities for working with the Go AST. |
|
buildutil
Package buildutil provides utilities related to the go/build package in the standard library.
|
Package buildutil provides utilities related to the go/build package in the standard library. |
|
callgraph
Package callgraph defines the call graph and various algorithms and utilities to operate on it.
|
Package callgraph defines the call graph and various algorithms and utilities to operate on it. |
|
callgraph/cha
Package cha computes the call graph of a Go program using the Class Hierarchy Analysis (CHA) algorithm.
|
Package cha computes the call graph of a Go program using the Class Hierarchy Analysis (CHA) algorithm. |
|
callgraph/rta
This package provides Rapid Type Analysis (RTA) for Go, a fast algorithm for call graph construction and discovery of reachable code (and hence dead code) and runtime types.
|
This package provides Rapid Type Analysis (RTA) for Go, a fast algorithm for call graph construction and discovery of reachable code (and hence dead code) and runtime types. |
|
callgraph/static
Package static computes the call graph of a Go program containing only static call edges.
|
Package static computes the call graph of a Go program containing only static call edges. |
|
gccgoexportdata
Package gccgoexportdata provides functions for reading export data files containing type information produced by the gccgo compiler.
|
Package gccgoexportdata provides functions for reading export data files containing type information produced by the gccgo compiler. |
|
gcexportdata
Package gcexportdata provides functions for locating, reading, and writing export data files containing type information produced by the gc compiler.
|
Package gcexportdata provides functions for locating, reading, and writing export data files containing type information produced by the gc compiler. |
|
internal/gccgoimporter
Package gccgoimporter implements Import for gccgo-generated object files.
|
Package gccgoimporter implements Import for gccgo-generated object files. |
|
internal/gcimporter
Package gcimporter provides various functions for reading gc-generated object files that can be used to implement the Importer interface defined by the Go 1.5 standard library package.
|
Package gcimporter provides various functions for reading gc-generated object files that can be used to implement the Importer interface defined by the Go 1.5 standard library package. |
|
loader
Package loader loads a complete Go program from source code, parsing and type-checking the initial packages plus their transitive closure of dependencies.
|
Package loader loads a complete Go program from source code, parsing and type-checking the initial packages plus their transitive closure of dependencies. |
|
packages
Package packages loads Go packages for inspection and analysis.
|
Package packages loads Go packages for inspection and analysis. |
|
packages/gopackages
The gopackages command is a diagnostic tool that demonstrates how to use golang.org/x/tools/go/packages to load, parse, type-check, and print one or more Go packages.
|
The gopackages command is a diagnostic tool that demonstrates how to use golang.org/x/tools/go/packages to load, parse, type-check, and print one or more Go packages. |
|
pointer
Package pointer implements Andersen's analysis, an inclusion-based pointer analysis algorithm first described in (Andersen, 1994).
|
Package pointer implements Andersen's analysis, an inclusion-based pointer analysis algorithm first described in (Andersen, 1994). |
|
ssa
Package ssa defines a representation of the elements of Go programs (packages, types, functions, variables and constants) using a static single-assignment (SSA) form intermediate representation (IR) for the bodies of functions.
|
Package ssa defines a representation of the elements of Go programs (packages, types, functions, variables and constants) using a static single-assignment (SSA) form intermediate representation (IR) for the bodies of functions. |
|
ssa/interp
Package ssa/interp defines an interpreter for the SSA representation of Go programs.
|
Package ssa/interp defines an interpreter for the SSA representation of Go programs. |
|
types/typeutil
Package typeutil defines various utilities for types, such as Map, a mapping from types.Type to interface{} values.
|
Package typeutil defines various utilities for types, such as Map, a mapping from types.Type to interface{} values. |
|
vcs
Package vcs exposes functions for resolving import paths and using version control systems, which can be used to implement behavior similar to the standard "go get" command.
|
Package vcs exposes functions for resolving import paths and using version control systems, which can be used to implement behavior similar to the standard "go get" command. |
|
Package godoc is a work-in-progress (2013-07-17) package to begin splitting up the godoc binary into multiple pieces.
|
Package godoc is a work-in-progress (2013-07-17) package to begin splitting up the godoc binary into multiple pieces. |
|
analysis
Package analysis performs type and pointer analysis and generates mark-up for the Go source view.
|
Package analysis performs type and pointer analysis and generates mark-up for the Go source view. |
|
redirect
Package redirect provides hooks to register HTTP handlers that redirect old godoc paths to their new equivalents and assist in accessing the issue tracker, wiki, code review system, etc.
|
Package redirect provides hooks to register HTTP handlers that redirect old godoc paths to their new equivalents and assist in accessing the issue tracker, wiki, code review system, etc. |
|
static
Package static exports a map of static file content that supports the godoc user interface.
|
Package static exports a map of static file content that supports the godoc user interface. |
|
util
Package util contains utility types and functions for godoc.
|
Package util contains utility types and functions for godoc. |
|
vfs
Package vfs defines types for abstract file system access and provides an implementation accessing the file system of the underlying OS.
|
Package vfs defines types for abstract file system access and provides an implementation accessing the file system of the underlying OS. |
|
vfs/gatefs
Package gatefs provides an implementation of the FileSystem interface that wraps another FileSystem and limits its concurrency.
|
Package gatefs provides an implementation of the FileSystem interface that wraps another FileSystem and limits its concurrency. |
|
vfs/httpfs
Package httpfs implements http.FileSystem using a godoc vfs.FileSystem.
|
Package httpfs implements http.FileSystem using a godoc vfs.FileSystem. |
|
vfs/mapfs
Package mapfs file provides an implementation of the FileSystem interface based on the contents of a map[string]string.
|
Package mapfs file provides an implementation of the FileSystem interface based on the contents of a map[string]string. |
|
vfs/zipfs
Package zipfs file provides an implementation of the FileSystem interface based on the contents of a .zip file.
|
Package zipfs file provides an implementation of the FileSystem interface based on the contents of a .zip file. |
|
Package imports implements a Go pretty-printer (like package "go/format") that also adds or removes import statements as necessary.
|
Package imports implements a Go pretty-printer (like package "go/format") that also adds or removes import statements as necessary. |
|
internal
|
|
|
fastwalk
Package fastwalk provides a faster version of filepath.Walk for file system scanning tools.
|
Package fastwalk provides a faster version of filepath.Walk for file system scanning tools. |
|
Package playground registers HTTP handlers at "/compile" and "/share" that proxy requests to the golang.org playground service.
|
Package playground registers HTTP handlers at "/compile" and "/share" that proxy requests to the golang.org playground service. |
|
socket
Package socket implements an WebSocket-based playground backend.
|
Package socket implements an WebSocket-based playground backend. |
|
The present file format Present files have the following format.
|
The present file format Present files have the following format. |
|
refactor
|
|
|
eg
Package eg implements the example-based refactoring tool whose command-line is defined in golang.org/x/tools/cmd/eg.
|
Package eg implements the example-based refactoring tool whose command-line is defined in golang.org/x/tools/cmd/eg. |
|
importgraph
Package importgraph computes the forward and reverse import dependency graphs for all packages in a Go workspace.
|
Package importgraph computes the forward and reverse import dependency graphs for all packages in a Go workspace. |
|
rename
Package rename contains the implementation of the 'gorename' command whose main function is in golang.org/x/tools/cmd/gorename.
|
Package rename contains the implementation of the 'gorename' command whose main function is in golang.org/x/tools/cmd/gorename. |
|
satisfy
Package satisfy inspects the type-checked ASTs of Go packages and reports the set of discovered type constraints of the form (lhs, rhs Type) where lhs is a non-trivial interface, rhs satisfies this interface, and this fact is necessary for the package to be well-typed.
|
Package satisfy inspects the type-checked ASTs of Go packages and reports the set of discovered type constraints of the form (lhs, rhs Type) where lhs is a non-trivial interface, rhs satisfies this interface, and this fact is necessary for the package to be well-typed. |
Click to show internal directories.
Click to hide internal directories.