glice — v3 (Hopefully)

License and dependency checker for GoLang projects. Prints list of all dependencies, their URL, license and saves all the license files in /licenses.

Status/Intention

This code is in a sort of no-man's land state.

It has been updated from the fork to a level sufficient to meet the needs of a client. The client wants to submit the changes back to the original project (Glice) so that they do not need to maintain for their needs, but they have also asked me to only update to the level of meet their needs, at least for the time being, because they have other things for me to work on that they consider more urgent.

OTOH it if a major breaking change to the forked code so the original developer may have zero interest in merging it. But even if they do want to merge the code the README does not yet reflect the changes made nor is the functionality fixed yet that was broken during refactoring, all per the client's limits on my time (and I have had no free time to do on my own given the time required for the client's projects.)

Feel free to use at your own risk. Also, feel free to submit issues if you have questions you think could be quickly answered and/or if you would like to discuss submitting a PR to this fork at this repo.

TODO Needed before PR (IMO)

• Rewrite the README.md to document v3
• Implement Caching and TTL support
• Update .goReleaser.yaml and ensure it can produce a viable release.
• (Re)Implement full suite of tests
• (Re)Implement these commands:
  • report print — Generate a list of dependencies and licenses to Stdout.
    • Figure out how apply colors to different licenses.
  • licenses download — Download JSON of license from spdx.org's GitHub.
    • Add validation from this list to glice audit
  • test — TBD

Glice v2 README Follows

(This is NOT reflective of the hopeful-v3 branch)

Introduction

glice analyzes the go.mod file of your project and prints it in a tabular format [csv and json available as well] - name, URL, and license short-name (MIT, GPL...).

Installation

Download and install glice by executing:

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

To update:

    go get -u github.com/ribice/glice/v3

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 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__
- v (boolean - verbose) // If enabled, will log dependencies before fetching and printing them.
- fmt (string - format) // Format of the output. Defaults to table, other available options are `csv` and `json`.
- o (string - otuput) // Destination of the output, defaults to stdout. Other option is `file`.

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.

Authors

Who	What
Emir Ribic	Original author through v2.x
Mike Schinkel	Author of hopeful additions for v3