{"ok":true,"site":"pkg-go","host":"pkg.go.dev","about":"pkg.go.dev is the Go package and module index. This CLI uses its public JSON API (/v1) to search packages and to look up package and module metadata, versions, symbols, importers and vulnerabilities. It also reads a few server-rendered pages: package docs, the standard library listing and the golang.org/x sub-repositories.","commands":[{"command":"search-packages","summary":"Search Go packages by keyword, with an optional filter expression (e.g. on import counts) and cursor paging","params":[{"name":"q","type":"string","required":true,"description":"Search query (package name, keywords, or symbol such as io.Reader)"},{"name":"limit_value","type":"number","description":"Maximum number of results per page"},{"name":"filter","type":"string","description":"Go-expression filter over result fields, e.g. importedByCounts.packages > 1000 or hasPrefix(packagePath, \"github.com/\")"},{"name":"token","type":"string","description":"Page token: the nextPageToken from a previous response. Made-up values return 400."}],"exampleUrl":"https://clify-dev.netlify.app/pkg-go/search-packages?q=http+router&limit_value=10&filter=importedByCounts.packages+%3E+1000"},{"command":"get-package","summary":"Get metadata for a Go package (module, version, name, synopsis, latest flag, std flag), optionally at a specific version","params":[{"name":"path","type":"string","required":true,"description":"Package import path, slashes kept, e.g. github.com/gorilla/mux or net/http"},{"name":"version","type":"string","description":"Module version, semver like v1.7.0. Standard-library versions use the v1.27.2 form, not go1.27.2."},{"name":"module","type":"string","description":"Module path, used to disambiguate when the package path could belong to several modules"}],"exampleUrl":"https://clify-dev.netlify.app/pkg-go/get-package?version=v1.7.0"},{"command":"get-module","summary":"Get metadata for a Go module (latest or given version, commit time, repo URL, go.mod presence)","params":[{"name":"path","type":"string","required":true,"description":"Module path, slashes kept, e.g. github.com/gorilla/mux"},{"name":"version","type":"string","description":"Module version (semver, e.g. v1.8.0). Defaults to latest."}],"exampleUrl":"https://clify-dev.netlify.app/pkg-go/get-module"},{"command":"list-module-packages","summary":"List the packages contained in a Go module, with an optional filter (e.g. name == \"main\")","params":[{"name":"path","type":"string","required":true,"description":"Module path, slashes kept, e.g. github.com/gorilla/mux or golang.org/x/tools"},{"name":"version","type":"string","description":"Module version (semver). Defaults to latest."},{"name":"filter","type":"string","description":"Filter expression over package fields (path, name, synopsis), e.g. name == \"main\""},{"name":"token","type":"string","description":"Page token from the previous response's packages.nextPageToken"}],"exampleUrl":"https://clify-dev.netlify.app/pkg-go/list-module-packages"},{"command":"list-versions","summary":"List all versions of a Go module, with commit time, deprecation and retraction status","params":[{"name":"path","type":"string","required":true,"description":"Module path, slashes kept, e.g. github.com/gorilla/mux"},{"name":"filter","type":"string","description":"Filter expression over version fields, e.g. retracted == false or hasPrefix(version, \"v1.8\")"},{"name":"token","type":"string","description":"Page token from the previous response's nextPageToken"}],"exampleUrl":"https://clify-dev.netlify.app/pkg-go/list-versions"},{"command":"list-symbols","summary":"List exported symbols (types, funcs, methods, fields, consts, vars) of a Go package, optionally for a GOOS/GOARCH build context and filter","params":[{"name":"path","type":"string","required":true,"description":"Package import path, slashes kept, e.g. net/http or github.com/gorilla/mux"},{"name":"version","type":"string","description":"Module version. For the standard library use the v1.27.2 form; go1.22.0 returns 404."},{"name":"GOOS","type":"string","description":"Target OS build context, e.g. linux, windows, darwin, js"},{"name":"GOARCH","type":"string","description":"Target architecture build context, e.g. amd64, arm64, wasm"},{"name":"filter","type":"string","description":"Filter expression over symbol fields (name, kind, synopsis, parent), e.g. kind == \"Type\" or hasPrefix(name, \"Server\")"},{"name":"token","type":"string","description":"Page token from the previous response's symbols.nextPageToken"}],"exampleUrl":"https://clify-dev.netlify.app/pkg-go/list-symbols?GOOS=windows&GOARCH=amd64&filter=hasPrefix%28name%2C+%22Server%22%29"},{"command":"list-importers","summary":"List import paths of packages that import a given Go package (excluding packages in the same module), paged by cursor","params":[{"name":"path","type":"string","required":true,"description":"Package import path, slashes kept, e.g. github.com/gorilla/mux"},{"name":"filter","type":"string","description":"Filter expression on the importer path (variable `path`), e.g. hasPrefix(path, \"github.com/kubernetes\")"},{"name":"token","type":"string","description":"Page token from the previous response's importedBy.nextPageToken"}],"exampleUrl":"https://clify-dev.netlify.app/pkg-go/list-importers"},{"command":"list-vulns","summary":"List known Go vulnerabilities (from the Go vuln DB) affecting a module at a given version (latest by default)","params":[{"name":"path","type":"string","required":true,"description":"Module path, slashes kept, e.g. golang.org/x/net"},{"name":"version","type":"string","description":"Module version to check (semver, e.g. v0.1.0). Defaults to latest, which often has no known vulns."},{"name":"token","type":"string","description":"Page token from the previous response's nextPageToken"}],"exampleUrl":"https://clify-dev.netlify.app/pkg-go/list-vulns?version=v0.1.0"},{"command":"get-package-doc","summary":"Fetch the rendered documentation page of a package (README, doc text, repo link), optionally at a version (path@version) and GOOS","params":[{"name":"path","type":"string","required":true,"description":"Import path, slashes kept, optionally suffixed with @version, e.g. github.com/gorilla/mux, github.com/gorilla/mux@v1.7.0, net/http"},{"name":"GOOS","type":"string","description":"Build context to render docs for, e.g. windows, linux, darwin, js"}],"exampleUrl":"https://clify-dev.netlify.app/pkg-go/get-package-doc"},{"command":"list-std-packages","summary":"List the Go standard library packages with links and synopses","params":[],"exampleUrl":"https://clify-dev.netlify.app/pkg-go/list-std-packages"},{"command":"list-subrepos","summary":"List the official Go sub-repositories (golang.org/x/...) with short descriptions","params":[],"exampleUrl":"https://clify-dev.netlify.app/pkg-go/list-subrepos"}]}