tools/

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

Links

Open Source Insights

README ¶

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 oracle 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.

To submit changes to this repository, see http://golang.org/doc/contribute.html.

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
astutil Package astutil contains common utilities for working with the Go AST.	Package astutil contains common utilities for working with the Go AST.
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'.
blog 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 The bundle command concatenates the source files of a package, renaming package-level names by adding a prefix and renaming identifiers as needed to preserve referential integrity.	The bundle command concatenates the source files of a package, renaming package-level names by adding a prefix and renaming identifiers as needed to preserve referential integrity.
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.
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.
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 does syntactic and semantic analysis of Go files and packages like the front-end of a Go compiler.	The gotype command does syntactic and semantic analysis of Go files and packages like the front-end of a Go compiler.
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.
oracle oracle: a tool for answering questions about Go source code.	oracle: a tool for answering questions about Go source code.
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 of episodic failures.	The stress utility is intended for catching of episodic 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 tipgodoc is the beginning of the new tip.golang.org server, serving the latest HEAD straight from the Git oven.	Command tipgodoc is the beginning of the new tip.golang.org server, serving the latest HEAD straight from the Git oven.
vet Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string.	Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string.
vet/whitelist Package whitelist defines exceptions for the vet tool.	Package whitelist defines exceptions for the vet tool.
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.
cover 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".
dashboard
builder Go Builder is a continuous build client for the Go project.	Go Builder is a continuous build client for the Go project.
coordinator The coordinator runs on GCE and coordinates builds in Docker containers.	The coordinator runs on GCE and coordinates builds in Docker containers.
updater
watcher Command watcher watches the specified repository for new commits and reports them to the build dashboard.	Command watcher watches the specified repository for new commits and reports them to the build dashboard.
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.
exact Package exact implements Values representing untyped Go constants and the corresponding operations.	Package exact implements Values representing untyped Go constants and the corresponding operations.
gccgoimporter Package gccgoimporter implements Import for gccgo-generated object files.	Package gccgoimporter implements Import for gccgo-generated object files.
gcimporter Package gcimporter implements Import for gc-generated object files.	Package gcimporter implements Import for gc-generated object files.
importer package importer implements an exporter and importer for Go export data.	package importer implements an exporter and importer for Go export data.
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.
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.
ssa/ssautil
types Package types declares the data types and implements the algorithms for type-checking of Go packages.	Package types declares the data types and implements the algorithms for type-checking of Go packages.
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
godoc 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.
imports 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.
oracle Package oracle contains the implementation of the oracle tool whose command-line is provided by golang.org/x/tools/cmd/oracle.	Package oracle contains the implementation of the oracle tool whose command-line is provided by golang.org/x/tools/cmd/oracle.
serial Package serial defines the oracle's schema for structured data serialization using JSON, XML, etc.	Package serial defines the oracle's schema for structured data serialization using JSON, XML, etc.
playground 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.
present 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.
lexical Package lexical computes the structure of the lexical environment, including the definition of and references to all universal, package-level, file-level and function-local entities.	Package lexical computes the structure of the lexical environment, including the definition of and references to all universal, package-level, file-level and function-local entities.
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.