https://github.com/uudashr/gopkgs

gopkgs - Tool to get list available Go packages
https://github.com/uudashr/gopkgs

go golang tool

Last synced: about 8 hours ago
JSON representation

gopkgs - Tool to get list available Go packages

• Host: GitHub
• URL: https://github.com/uudashr/gopkgs
• Owner: uudashr
• License: mit
• Created: 2017-09-15T09:39:04.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-03-29T03:43:30.000Z (almost 3 years ago)
• Last Synced: 2025-01-03T17:15:05.303Z (7 days ago)
• Topics: go, golang, tool
• Language: Go
• Homepage:
• Size: 108 KB
• Stars: 121
• Watchers: 8
• Forks: 34
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/uudashr/gopkgs.svg?branch=master)](https://travis-ci.org/uudashr/gopkgs)[![GoDoc](https://godoc.org/github.com/uudashr/gopkgs?status.svg)](https://godoc.org/github.com/uudashr/gopkgs)

# gopkgs

`gopkgs` is a tool that provides list of available Go packages that can be imported.

This is an alternative to `go list all`, just faster.

## Installation

`$ go get -u github.com/uudashr/gopkgs/cmd/gopkgs`

or, using **Go 1.12+**:

`$ go install github.com/uudashr/gopkgs/v2/cmd/gopkgs@latest`

## Usage

### Tool

```plaintext

$ gopkgs -help

Usage of gopkgs:

  -format string

    	custom output format (default "{{.ImportPath}}")

  -help

    	show this message

  -no-vendor

    	exclude vendor dependencies except under workDir (if specified)

  -workDir string

    	importable packages only for workDir

Use -format to custom the output using template syntax. The struct being passed to template is:

    type Pkg struct {

        Dir        string // directory containing package sources

        ImportPath string // import path of package in dir

        Name       string // package name

        Standard   bool   // is this package part of the standard Go library?

    }

Use -workDir={path} to speed up the package search. This will ignore any vendor package outside the package root.

```

### Library

This project adheres to the Go modules [release strategy](https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher) by using the `Major subdirectory` approach.

Starting from version `v2.0.3`, you're able to use either `github.com/uudashr/gopkgs` or `github.com/uudashr/gopkgs/v2` versions independently.

The tool `cmd/gopkgs` uses `v2` package internally.

### Example

Get package name along with the import path.

```plaintext

$ gopkgs -format "{{.Name}};{{.ImportPath}}"

testing;github.com/mattes/migrate/source/testing

http;github.com/stretchr/testify/http

ql;github.com/mattes/migrate/database/ql

pkgtree;github.com/golang/dep/internal/gps/pkgtree

sqlite3;github.com/mattes/migrate/database/sqlite3

gps;github.com/golang/dep/internal/gps

spanner;github.com/mattes/migrate/database/spanner

dep;github.com/golang/dep

shortener;github.com/uudashr/shortener

bindata;github.com/mattes/migrate/source/go-bindata

postgres;github.com/mattes/migrate/database/postgres

test;github.com/vektra/mockery/mockery/fixtures

awss3;github.com/mattes/migrate/source/aws-s3

```

### Tips

Use `-workDir={path}` flag, it will speed up the package search by ignoring the external vendor.

## Related Project

This is based on  but takes slightly different path by simplifying its implementation.