Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
cmd
 
 
mod
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

glice

Build Status Coverage Status Go Report Card

Golang license and dependency checker. Prints list of all dependencies, their URL, license and saves all the license files in /licenses.

Introduction

glice analyzes the go.mod file of your project and prints it in a tabular format - name, URL, and license short-name (MIT, GPL...).

Installation

Download and install glice by executing:

    go get github.com/ribice/glice
    go install github.com/ribice/glice/cmd/glice.go

To update:

    go get -u github.com/ribice/glice

Usage

To run glice, navigate to a folder with go.mod and execute:

    glice

Alternatively, you can provide path which you want to be scanned with -p flag:

    glice -p "github.com/ribice/glice"

By default glice:

  • Prints only to stdout

  • Gets dependencies from go.mod

  • Fetches licenses for dependencies hosted on GitHub

  • Is limited to 60 API calls on GitHub (up to 60 dependencies from github.com). API key can be provided by setting GITHUB_API_KEY environment variable.

All flags are optional. Glice supports the following flags:

- f [boolean, fileWrite] // Writes all licenses to /licenses dir
- i [boolean, indirect] // Parses indirect dependencies as well
- p [string - path] // Path to be scanned in form of github.com/author/repo
- t [boolean - thanks] // if GitHub API key is provided, setting this flag will star all GitHub repos from dependency. __In order to do this, API key must have access to public_repo__

Don't forget -help flag for detailed usage information.

Using glice inside as a library

As of v2.0.0 glice can be used as a library and provides few functions/methods that return list of dependencies in structured format and printing to io.Writer.

Sample output

Executing glice -c on github.com/ribice/glice prints (with additional colors for links and licenses):

+-----------------------------------+-------------------------------------------+--------------+
|            DEPENDENCY             |                  REPOURL                  |   LICENSE    |
+-----------------------------------+-------------------------------------------+--------------+
| github.com/fatih/color            | https://github.com/fatih/color            | MIT          |
| github.com/google/go-github       | https://github.com/google/go-github       | bsd-3-clause |
| github.com/keighl/metabolize      | https://github.com/keighl/metabolize      | Other        |
| github.com/olekukonko/tablewriter | https://github.com/olekukonko/tablewriter | MIT          |
| golang.org/x/mod                  | https://go.googlesource.com/mod           |              |
| golang.org/x/oauth2               | https://go.googlesource.com/oauth2        |              |
+-----------------------------------+-------------------------------------------+--------------+

License

glice is licensed under the MIT license. Check the LICENSE file for details.

Author

Emir Ribic